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
________________________________________________________________________

-*/

#include "basicmod.h"
#include "bufstringset.h"


namespace File
{

mExpClass(Basic) Path
{
public:

    enum Style          { Local, Unix, Windows };

                        Path(const char* fullinp=0);
                        Path(const char* p1,const char* p2,const char* p3=0,
                                 const char* p4=0,const char* p5=0);
                        Path( const Path& fp )  { *this = fp; }
                        Path(const Path&,const char* p2,
                                 const char* p3=0,const char* p4=0,
                                 const char* p5=0);

    Path&               operator =(const Path&);
    Path&               operator =(const char* fullinp);
    bool                operator ==(const Path&) const;
    bool                operator ==(const char* fnm) const;
    bool                operator !=(const Path&) const;
    bool                operator !=(const char* fnm) const;
    bool                isEmpty() const         { return lvls_.isEmpty(); }

    Path&               set(const char* fullinp);
    Path&               add(const char*);       
    Path&               insert(const char*);    
    Path&               setFileName(const char*); 
    Path&               setPath(const char*);   
    Path&               setExtension(const char*,bool replace=true);

    bool                isAbsolute() const;
    bool                isSubDirOf(const Path&,Path* reldir = 0) const;
    bool                makeRelativeTo(const Path&);
    bool                makeCanonical();

    BufferString        fullPath(Style s=Local,bool cleanup=true) const;
    const char*         prefix() const;
    const char*         postfix() const;
    int                 nrLevels() const;
    const char*         extension() const;      

    const OD::String&   fileName() const;
    BufferString        baseName() const; 
    BufferString        pathOnly() const;
    BufferString        winDrive() const;

    const OD::String&   dir(int nr=-1) const;
    BufferString        dirUpTo(int) const;

    static BufferString getTempDir();
    static BufferString getTempName(const char* ext=0);
    static BufferString mkCleanPath(const char* path,Style fmt);
    static BufferString getTimeStampFileName(const char*ext=0);

    const char*         dirSep() const;
    static const char*  dirSep(Style);
    static const char*  sPrefSep;

protected:

    bool                isuri_;
    bool                isabs_;
    BufferString        prefix_;
    BufferString        postfix_;           
    BufferStringSet     lvls_;

    void                addPart(const char*);
    void                compress(int sl=0);
    void                conv2TrueDirIfLink();
};

} // namespace File;


mDeprecated typedef File::Path FilePath;