file.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Nanne Hemstra
 Date:          January 2010
 Contents:      File utitlities
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "basicmod.h"
#include "enums.h"
#include "gendefs.h"
#include "timefun.h"
 
class BufferStringSet;
class Executor;
 
 
namespace File
{
 
mGlobal(Basic) bool             exists(const char*);
mGlobal(Basic) bool             isReadable(const char*);
mGlobal(Basic) bool             isEmpty(const char*);
mGlobal(Basic) bool             isDirEmpty(const char*);
mGlobal(Basic) bool             isFile(const char*);
mGlobal(Basic) bool             isDirectory(const char*);
mGlobal(Basic) BufferString     findExecutable(const char* exenm,
                                               const BufferStringSet& paths,
                                               bool includesyspath=true );
 
mGlobal(Basic) const char*      getCanonicalPath(const char*);
mGlobal(Basic) const char*      getAbsolutePath(const char* dir,
                                                const char* relfnm);
mGlobal(Basic) const char*      getRelativePath(const char* reltodir,
                                                const char* fnm);
mGlobal(Basic) void             makeRecursiveFileList(const char* dir,
                                        BufferStringSet& filelist,
                                        bool followlinks=false);
 
mGlobal(Basic) bool             createLink(const char* from,const char* to);
mGlobal(Basic) bool             isLink(const char*);
mGlobal(Basic) const char*      linkTarget(const char* linkname);
mGlobal(Basic) const char*      linkEnd(const char* linkname);
mGlobal(Basic) const char*      linkValue(const char* linkname);
 
mGlobal(Basic) void             hide(const char*,bool yn); 
mGlobal(Basic) bool             isHidden(const char*);
mGlobal(Basic) bool             isWritable(const char*);
mGlobal(Basic) bool             makeWritable(const char*,bool yesno,
                                        bool recursive);
mGlobal(Basic) bool             makeReadOnly(const char* fnm, bool recursive);
mGlobal(Basic) bool             isExecutable(const char*);
mGlobal(Basic) bool             makeExecutable(const char*,bool yesno);
mGlobal(Basic) void             setSystemFileAttrib(const char*,bool yn);
mGlobal(Basic) bool             hasSystemFileAttrib(const char*);
mGlobal(Basic) bool             setPermissions(const char*,const char* perms,
                                        bool recursive);
mGlobal(Basic) bool             isInUse(const char* fnm);
 
mDeprecated                     ("Use isInUse instead")
mGlobal(Basic) bool             isFileInUse(const char* fnm);
 
enum DirListType                { AllEntriesInDir, FilesInDir, DirsInDir };
mGlobal(Basic) bool             listDir(const char*,DirListType,
                                    BufferStringSet& fnames,const char* mask=0);
mGlobal(Basic) bool             createDir(const char*);
mGlobal(Basic) bool             rename(const char* oldname,const char* newname,
                                       uiString* errmsg=nullptr);
mGlobal(Basic) bool             copy(const char* from,const char* to,
                                        BufferString* errmsg=0);
mGlobal(Basic) Executor*        getRecursiveCopier(const char* from,
                                               const char* to);
mGlobal(Basic) Executor*        getRecursiveDeleter(const char* dirnm,
                                        const BufferStringSet* externallist=0,
                                        bool filesonly=false);
mGlobal(Basic) bool             resize(const char*,od_int64);
mGlobal(Basic) bool             remove(const char*);
mGlobal(Basic) bool             saveCopy(const char* from,const char* to);
mGlobal(Basic) bool             copyDir(const char* from,const char* to,
                                        BufferString* errmsg=0);
mGlobal(Basic) bool             removeDir(const char*);
mGlobal(Basic) bool             changeDir(const char* path);
 
mGlobal(Basic) bool             getContent(const char*,BufferString&);
mGlobal(Basic) od_int64         getFileSize(const char* fnm,
                                        bool followlink=true); 
mGlobal(Basic) od_int64         getKbSize(const char*);
mGlobal(Basic) BufferString     getFileSizeString(od_int64 fileszinkb);
mGlobal(Basic) BufferString     getFileSizeString(const char* fnm);
 
mGlobal(Basic) const char*      timeCreated(const char* filenm,
                                        const char* fmt=Time::defDateTimeFmt());
mGlobal(Basic) const char*      timeLastModified(const char* filenm,
                                        const char* fmt=Time::defDateTimeFmt());
mGlobal(Basic) od_int64         getTimeInSeconds(const char*,bool modif=true);
mGlobal(Basic) od_int64         getTimeInMilliSeconds( const char* fnm,
                                         bool lastmodif=true );//since day start
 
mGlobal(Basic) const char*      getCurrentPath();
mGlobal(Basic) const char*      getHomePath();
mGlobal(Basic) const char*      getTempPath();
mGlobal(Basic) const char*      getUserAppDataPath();
mGlobal(Basic) const char*      getRootPath(const char* path);
 
mGlobal(Basic) const char*      asciiFilesFilter();
mGlobal(Basic) const char*      allFilesFilter();
mGlobal(Basic) const char*      textFilesFilter();
 
 
enum ViewStyle { Text, Table, Log, Bin };
mDeclareNameSpaceEnumUtils(Basic,ViewStyle)
 
mClass(Basic) ViewPars
{
public:
 
                                ViewPars( ViewStyle vs=Text )
                                    : style_(vs)
                                    , editable_(false)
                                    , maxnrlines_(vs==Table ? 500 : 10000) {}
 
    static const char*          sKeyFile()      { return "file"; }
    static const char*          sKeyMaxLines()  { return "maxlines"; }
    static const char*          sKeyStyle()     { return "style"; }
    static const char*          sKeyEdit()      { return "edit"; }
 
    ViewStyle                   style_;
    int                         maxnrlines_;    
    bool                        editable_;      
 
};
 
mGlobal(Basic) bool             launchViewer(const char*,
                                        const ViewPars& vp=ViewPars());
 
                                /* Internal use only: */
mGlobal(Basic) bool             initTempDir();
 
 
} // namespace File