xmipp_filename.h

Go to the documentation of this file.

/***************************************************************************
 * Authors:     Carlos Oscar S. Sorzano (coss@cnb.csic.es)
 *
 *
 * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307  USA
 *
 *  All comments concerning this program package may be sent to the
 *  e-mail address 'xmipp@cnb.csic.es'
 ***************************************************************************/

#ifndef CORE_XMIPP_FILENAME_H_
#define CORE_XMIPP_FILENAME_H_

//#ifdef HAVE_UNISTD_H
#include <unistd.h>
//#endif /* HAVE_UNISTD_H */

#include "xmipp_strings.h"

#ifndef __MINGW32__
#include <fcntl.h>
#endif

#define FILENAMENUMBERLENGTH 6

typedef struct stat Stat;

//extern variable with magic Word  used to define metadata version
// xmipp XMIPP_STAR_1
// sqlite SQLite format 3

#define METADATA_XMIPP_STAR "# XMIPP_STAR_1"
#define METADATA_XMIPP_SQLITE "SQLite format 3"


#define AT '@'
#define COMMA ','
#define COLON ':'
#define NUM '#'


class FileName: public String
{
public:

    inline FileName(): String("")
    {}

    FileName(const String& str): String(str)
    {}

    FileName(const char* str) : String(str)
    {}

    FileName& operator=(const FileName& op)
    {
        return (FileName&) std::string::operator=(op);
    }

    FileName(const FileName& fn) : String(fn)
    {}

    FileName(const char* str, int no, const String& ext = "")
    {
        compose(str, no, ext);
    }

    FileName(const char* str, const String& ext): String(str + ext)
    {}

    FileName(const String& str, const String& ext): String(str + "." + ext)
    {}


    inline String getString() const
    {
        return (String)(*this);
    }

    inline bool isEmpty() const
    {
        return *this == "";
    }

    void compose(const String& str, const size_t no, const String& ext = "");

    void compose(const size_t no, const String& str);


    // Constructor: prefix number, filename root and extension, mainly for selfiles..
    void compose(size_t no , const String &str , const String &ext);

    // Constructor: string  and filename, mainly for metadata blocks..
    void compose(const String &blockName , const String &str);

    void composeBlock(const String &blockName, size_t no, const String &str, const String &ext="");


    bool isInStack() const;

    void decompose(size_t &no, String& str) const;

    FileName getDecomposedFileName() const;

    FileName getRoot() const;

    FileName getBaseName() const;

    int getNumber() const;

    size_t getPrefixNumber(size_t pos = 0) const;

    FileName getDir() const;

    String getExtension() const;

    String getFileFormat() const;

    bool hasImageExtension() const;

    bool hasStackExtension() const;

    bool hasVolumeExtension() const;

    bool hasMetadataExtension() const;

    size_t getFileSize() const;


    String getBlockName() const;

    FileName removePrefixNumber() const;

    FileName removeBlockName() const;

    FileName removeAllPrefixes() const;

    void initRandom(int length);

    void initUniqueName(const char * templateStr = "xmippTemp_XXXXXX", const String &fnDir="");



    FileName toLowercase() const;

    FileName toUppercase() const;

    bool contains(const String& str) const;

    FileName beforeFirstOf(const String& str) const;

    FileName beforeLastOf(const String& str) const;

    FileName afterFirstOf(const String& str) const;

    FileName afterLastOf(const String& str) const;

    FileName addPrefix(const String& prefix) const;

    FileName addExtension(const String& ext) const;

    FileName withoutExtension() const;

    FileName withoutRoot() const;

    FileName insertBeforeExtension(const String& str) const;

    FileName removeExtension(const String& ext) const;

    FileName removeLastExtension() const;


    FileName removeFilename() const;

    FileName removeAllExtensions() const;

    FileName removeFileFormat() const;

    bool isMetaData(bool failIfNotExists=true) const;

    bool isStar1(bool failIfNotExists) const;

    FileName replaceSubstring(const String& subOld, const String& subNew) const;

    FileName replaceCharacter(char oldChar, char newChar) const;

    FileName replaceExtension(const String& newExt) const;

    FileName removeSubstring(const String& sub) const;

    FileName removeUntilPrefix(const String& prefix) const;

    FileName removeDirectories(int keep = 0) const;
    void copyFile(const FileName & target) const;

    // This function is in funcs, cannot be here because need metadata_generic and metadata_generic
    // need filename
    //    /* Copy one image
    //     *
    //     */
    //    void copyImage(const FileName & target) const;

    bool exists() const;

    void deleteFile() const;

    bool existsTrim() const;

    bool isDir() const;

    void getFiles(std::vector<FileName> &files) const;

    void waitUntilStableSize(size_t time_step = 250000);

    void createEmptyFile(size_t size, size_t block_size = 102400);

    void createEmptyFileWithGivenLength(size_t length = 0) const;

    int makePath(mode_t mode = 0755) const;

    void assertExists();
};

char* getXmippPath();

char* getXmippSrcPath();

inline bool fileExists( const char *filename )
{
    // do not use stat since updates the atime flag. This may be dangerous
    // for mpi processes in which the same file is accessed many times
    // from different computers even if not writting is made 
    //return ( stat(filename, &buffer) == 0 ? true : false );
    return ( access (filename, F_OK)  == 0 ? true : false);

}

inline bool fileExists( const FileName &filename )
{
    return fileExists(filename.c_str());
}

void copyImage(const FileName & source,const FileName & target);

void deleteFile(const FileName &fn);

//Functions to make easy to change the magicWord used to identify the
//file format of metadata
extern String FileNameVersion;
void setMetadataVersion(String version);
String getMetadataVersion(void);

class FileNameComparison
{
public:
    inline bool operator ()(const FileName &fn1, const FileName &fn2)
    {
        return fn1<fn2;
    }
};


class FileLock
{
protected:


#ifndef __MINGW32__
    struct flock fl;
#endif

    bool islocked;
    int  filenum;

public:

    FileLock()
    {
#ifndef __MINGW32__
        fl.l_type   = F_WRLCK;  /* F_RDLCK, F_WRLCK, F_UNLCK    */
        fl.l_whence = SEEK_SET; /* SEEK_SET, SEEK_CUR, SEEK_END */
        fl.l_start  = 0;        /* Offset from l_whence         */
        fl.l_len    = 0;        /* length, 0 = to EOF           */
        fl.l_pid    = getpid(); /* our PID                      */

        islocked = false;
        filenum = 0;
#endif
    }

    FileLock(int fileno)
    {
        FileLock();
        this->filenum = fileno;
    }

    void lock(int fileno = 0);
    void lock(FILE* file);

    void unlock();

};


#endif /* FILENAME_H_ */