filepath.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          Mar 2004
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "basicmod.h"
#include "bufstringset.h"
 
 
mExpClass(Basic) FilePath
{
public:
    enum Style          { Local, Unix, Windows };
 
                        FilePath(const char* fullinp=0);
                        FilePath(const char* p1,const char* p2,const char* p3=0,
                                 const char* p4=0,const char* p5=0);
                        FilePath( const FilePath& fp )  { *this = fp; }
                        FilePath(const FilePath&,const char* p2,
                                 const char* p3=0,const char* p4=0,
                                 const char* p5=0);
 
    FilePath&           operator =(const FilePath&);
    FilePath&           operator =(const char* fullinp);
    bool                operator ==(const FilePath&) const;
    bool                operator ==(const char* fnm) const;
    bool                operator !=(const FilePath&) const;
    bool                operator !=(const char* fnm) const;
    bool                isEmpty() const;
 
    FilePath&           set(const char* fullinp);
    FilePath&           add(const char*);       
    FilePath&           insert(const char*);    
    void                setFileName(const char*); 
    void                setPath(const char*);   
    void                setExtension(const char*,bool replace=true);
    bool                exists() const;
 
    bool                isAbsolute() const;
    bool                isSubDirOf(const FilePath&,FilePath* reldir = 0) const;
    bool                makeRelativeTo(const FilePath&);
    bool                makeCanonical();
 
    BufferString        fullPath(Style s=Local,bool cleanup=true) const;
    const char*         prefix() const;
    int                 nrLevels() const;
    const char*         extension() const;      
 
    const OD::String&   fileName() const;
    BufferString        baseName() const; 
    BufferString        pathOnly() const;
    BufferString        pathOnly(Style) const;
    BufferString        winDrive() const;
 
    const OD::String&   dir(int nr=-1) const;
    BufferString        dirUpTo(int) const;
    BufferString        partitionName() const;
    BufferString        rootPath() const;
 
    static BufferString getTempDir();
    static BufferString getTempFileName(const char* typ,const char* ext);
    static BufferString getTempFullPath(const char* typ,const char* ext);
    static BufferString getTimeStampFileName(const char* ext);
    mDeprecated("Use getTempFullPath instead")
    static BufferString getTempName( const char* ext=0 )
                        { return getTempFullPath(0,ext); }
    static BufferString mkCleanPath(const char* path,Style fmt);
 
    static const char*  dirSep(Style);
    static const char*  sPrefSep;
 
    static BufferString getFullLongPath(const FilePath&);
 
protected:
 
    bool                isabs_;
    BufferString        prefix_;
    BufferStringSet     lvls_;
 
    void                addPart(const char*);
    void                compress(int sl=0);
    void                trueDirIfLink();
};
 
 
mGlobal(Basic) inline const char* sSeismicSubDir()      { return "Seismics"; }
mGlobal(Basic) inline const char* sWellSubDir()         { return "WellInfo"; }
mGlobal(Basic) inline const char* sSurfaceSubDir()      { return "Surfaces"; }
 
mGlobal(Basic) inline const char* sParFileExtension()   { return "par"; }
mGlobal(Basic) inline const char* sInfoFileExtension()  { return "info"; }
mGlobal(Basic) inline const char* sProcFileExtension()  { return "proc"; }
mGlobal(Basic) inline const char* sStatsFileExtension() { return "stats"; }