OpendTect  6.3
file.h
Go to the documentation of this file.
1 #pragma once
2 
3 /*+
4 ________________________________________________________________________
5 
6  (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
7  Author: Nanne Hemstra
8  Date: January 2010
9  Contents: File utitlities
10 ________________________________________________________________________
11 
12 -*/
13 
14 #include "basicmod.h"
15 
16 #include "enums.h"
17 #include "factory.h"
18 #include "gendefs.h"
19 #include "strmdata.h"
20 #include "timefun.h"
21 
22 class BufferStringSet;
23 class Executor;
24 class uiString;
25 
26 
29 namespace File
30 {
31 
32 mGlobal(Basic) bool exists(const char*);
33 mGlobal(Basic) bool isReadable(const char*);
34 mGlobal(Basic) bool isEmpty(const char*);
35 mGlobal(Basic) bool isDirEmpty(const char*);
36 mGlobal(Basic) bool isFile(const char*);
37 mGlobal(Basic) bool isDirectory(const char*);
38 mGlobal(Basic) bool isURI(const char*&);
40 
41 mGlobal(Basic) const char* getCanonicalPath(const char*);
42 mGlobal(Basic) const char* getRelativePath(const char* reltodir,
43  const char* fnm);
44 mGlobal(Basic) void makeRecursiveFileList(const char* dir,
45  BufferStringSet& filelist,
46  bool followlinks=false);
47 
48 mGlobal(Basic) bool createLink(const char* from,const char* to);
49 mGlobal(Basic) bool isLink(const char*);
50 mGlobal(Basic) const char* linkTarget(const char* linkname);
52 mGlobal(Basic) const char* linkEnd(const char* linkname);
55 mGlobal(Basic) const char* linkValue(const char* linkname);
57 
58 mGlobal(Basic) void hide(const char*,bool yn);
59 mGlobal(Basic) bool isHidden(const char*);
60 mGlobal(Basic) bool isWritable(const char*);
61 mGlobal(Basic) bool makeWritable(const char*,bool yesno,
62  bool recursive);
63 mGlobal(Basic) bool isExecutable(const char*);
64 mGlobal(Basic) bool makeExecutable(const char*,bool yesno);
65 mGlobal(Basic) bool setPermissions(const char*,const char* perms,
66  bool recursive);
67 mGlobal(Basic) bool isInUse(const char* fnm);
68 
69 mGlobal(Basic) bool createDir(const char*);
70 mGlobal(Basic) bool rename(const char* oldname,const char* newname);
71 mGlobal(Basic) bool copy(const char* from,const char* to,
72  uiString* errmsg=0);
73 mGlobal(Basic) Executor* getRecursiveCopier(const char* from,
74  const char* to);
75 mGlobal(Basic) Executor* getRecursiveDeleter(const char* dirnm,
76  const BufferStringSet* externallist=0,
77  bool filesonly=false);
78 mGlobal(Basic) bool resize(const char*,od_int64);
79 mGlobal(Basic) bool remove(const char*);
80 mGlobal(Basic) bool saveCopy(const char* from,const char* to);
81 mGlobal(Basic) bool copyDir(const char* from,const char* to,
82  uiString* errmsg=0);
83 mGlobal(Basic) bool removeDir(const char*);
84 mGlobal(Basic) bool changeDir(const char* path);
85 mGlobal(Basic) bool checkDirectory(const char* fnm,bool forread,
86  uiString& errmsg);
90 mGlobal(Basic) bool getContent(const char*,BufferString&);
91 mGlobal(Basic) od_int64 getFileSize(const char* fnm,
92  bool followlink=true);
93 mGlobal(Basic) od_int64 getKbSize(const char*);
94 mGlobal(Basic) BufferString getFileSizeString(od_int64 fileszinkb);
95 mGlobal(Basic) BufferString getFileSizeString(const char* fnm);
96 
97 mGlobal(Basic) const char* timeCreated(const char* filenm,
98  const char* fmt=Time::defDateTimeFmt());
99 mGlobal(Basic) const char* timeLastModified(const char* filenm,
100  const char* fmt=Time::defDateTimeFmt());
101 mGlobal(Basic) od_int64 getTimeInSeconds(const char*,bool modif=true);
102 
103 mGlobal(Basic) const char* getCurrentPath();
104 mGlobal(Basic) const char* getHomePath();
105 mGlobal(Basic) const char* getTempPath();
106 mGlobal(Basic) const char* getRootPath(const char* path);
107 
108 
109 enum ViewStyle { Text, Table, Log, Bin };
110 mDeclareNameSpaceEnumUtils(Basic,ViewStyle)
111 
112 mClass(Basic) ViewPars
113 {
114 public:
115 
116  ViewPars( ViewStyle vs=Text )
117  : style_(vs)
118  , editable_(false)
119  , maxnrlines_(vs==Table ? 500 : 10000) {}
120 
121  static const char* sKeyFile() { return "file"; }
122  static const char* sKeyMaxLines() { return "maxlines"; }
123  static const char* sKeyStyle() { return "style"; }
124  static const char* sKeyEdit() { return "edit"; }
125 
126  ViewStyle style_;
127  int maxnrlines_;
128  bool editable_;
129 
130 };
131 
132 mGlobal(Basic) bool launchViewer(const char*,
133  const ViewPars& vp=ViewPars());
134 
135 
136 mExpClass(Basic) SystemAccess : public RefCount::Referenced
137 {
138 public:
139  static
140  RefMan<SystemAccess> get(const char* fnm);
145  virtual bool exists(const char*,bool forread) const = 0;
146  virtual bool isReadable(const char*) const = 0;
147  virtual bool isFile(const char*) const = 0;
148  virtual bool isDirectory(const char*) const = 0;
149 
150  virtual bool remove(const char*,bool recursive=true) const = 0;
151  virtual bool setWritable(const char*,bool yn,
152  bool recursive=true) const = 0;
153  virtual bool isWritable(const char*) const = 0;
154  virtual bool rename(const char* from,const char*) = 0;
155  virtual bool copy(const char* from,const char* to,
156  uiString* errmsg=0) const = 0;
157  virtual od_int64 getFileSize( const char* fnm, bool followlink ) = 0;
158 
159  virtual StreamData createOStream(const char*,
160  bool binary=true,
161  bool editmode=false) const = 0;
167  virtual StreamData createIStream(const char*,bool binary=true) const = 0;
169 
170  mDefineFactoryInClass(SystemAccess, factory);
171 
172  static BufferString getProtocol(const char* fnm,bool acceptnone);
173  static BufferString removeProtocol(const char*);
174 
175 protected:
176  virtual ~SystemAccess() {}
177 };
178 
179 
180 mExpClass(Basic) LocalFileSystemAccess : public SystemAccess
181 { mODTextTranslationClass(LocalFileSystemAccess);
182 public:
183  virtual bool exists(const char*,bool forread) const;
184  virtual bool isReadable(const char*) const;
185  virtual bool isFile(const char*) const;
186  virtual bool isDirectory(const char*) const;
187 
188  virtual bool remove(const char*,bool recursive=true) const;
189  virtual bool setWritable(const char*,bool yn,bool recursive) const;
190  virtual bool isWritable(const char*) const;
191  virtual bool rename(const char* from,const char*);
192  virtual bool copy(const char* from,const char* to,
193  uiString* errmsg=0) const;
194  virtual od_int64 getFileSize(const char*, bool followlink);
195 
196  virtual StreamData createOStream(const char*,
197  bool binary,bool editmode) const;
198 
199  virtual StreamData createIStream(const char*,bool binary) const;
200 
201  static void initClass();
202  static const char* sFactoryKeyword() { return "file"; }
203  static uiString sFactoryDisplayName() { return tr("Local file"); }
204 
205  virtual const char* factoryKeyword() const { return sFactoryKeyword(); }
206  virtual uiString factoryDisplayName() const
207  { return sFactoryDisplayName(); }
208 
209 
210 private:
211  static SystemAccess* createInstance() { return new LocalFileSystemAccess; }
212 };
213 
214 } // namespace File
File::rename
bool rename(const char *oldname, const char *newname)
File::copy
bool copy(const char *from, const char *to, uiString *errmsg=0)
mExpClass
#define mExpClass(module)
Definition: commondefs.h:157
File::isDirEmpty
bool isDirEmpty(const char *)
File
Interface for several file and directory related services.
Definition: file.h:29
File::ViewPars::editable_
bool editable_
only if possible
Definition: file.h:128
File::isLink
bool isLink(const char *)
File::ViewPars::sKeyStyle
static const char * sKeyStyle()
Definition: file.h:123
Time::defDateTimeFmt
const char * defDateTimeFmt()
File::isFile
bool isFile(const char *)
File::launchViewer
bool launchViewer(const char *, const ViewPars &vp=ViewPars())
File::makeWritable
bool makeWritable(const char *, bool yesno, bool recursive)
File::getRecursiveCopier
Executor * getRecursiveCopier(const char *from, const char *to)
File::checkDirectory
bool checkDirectory(const char *fnm, bool forread, uiString &errmsg)
Conv::to
T to(const F &fr)
Definition: convert.h:31
File::Table
Definition: file.h:109
File::timeLastModified
const char * timeLastModified(const char *filenm, const char *fmt=Time::defDateTimeFmt())
File::Text
Definition: file.h:109
File::isURI
bool isURI(const char *&)
if local, will remove &#39;file://&#39;
File::makeExecutable
bool makeExecutable(const char *, bool yesno)
mODTextTranslationClass
#define mODTextTranslationClass(clss)
Definition: uistring.h:37
mGlobal
#define mGlobal(module)
Definition: commondefs.h:160
mDeclareNameSpaceEnumUtils
#define mDeclareNameSpaceEnumUtils(mod, enm)
Definition: enums.h:205
File::SystemAccess::~SystemAccess
virtual ~SystemAccess()
Definition: file.h:176
od_int64
#define od_int64
Definition: plftypes.h:34
File::LocalFileSystemAccess::factoryDisplayName
virtual uiString factoryDisplayName() const
Definition: file.h:206
File::ViewPars::style_
ViewStyle style_
Definition: file.h:126
File::isHidden
bool isHidden(const char *)
File::isExecutable
bool isExecutable(const char *)
File::createDir
bool createDir(const char *)
File::Log
Definition: file.h:109
File::hide
void hide(const char *, bool yn)
only Windows
File::getRecursiveDeleter
Executor * getRecursiveDeleter(const char *dirnm, const BufferStringSet *externallist=0, bool filesonly=false)
uiString
Definition: uistring.h:88
BufferStringSet
Set of BufferString objects.
Definition: bufstringset.h:25
File::changeDir
bool changeDir(const char *path)
File::getFileSizeString
BufferString getFileSizeString(int64_t fileszinkb)
File::linkValue
const char * linkValue(const char *linkname)
not sure why and when to use - used by zip
File::ViewStyle
ViewStyle
Definition: file.h:109
File::getTempPath
const char * getTempPath()
File::getContent
bool getContent(const char *, BufferString &)
Table
Definition: geom2dascio.h:18
File::ViewPars::sKeyFile
static const char * sKeyFile()
Definition: file.h:121
File::isDirectory
bool isDirectory(const char *)
File::saveCopy
bool saveCopy(const char *from, const char *to)
File::ViewPars::sKeyMaxLines
static const char * sKeyMaxLines()
Definition: file.h:122
File::getFileSize
int64_t getFileSize(const char *fnm, bool followlink=true)
bytes
StreamData
Holds data to use and close an iostream.
Definition: strmdata.h:29
File::SystemAccess
Definition: file.h:136
File::LocalFileSystemAccess::sFactoryKeyword
static const char * sFactoryKeyword()
Definition: file.h:202
File::isReadable
bool isReadable(const char *)
File::timeCreated
const char * timeCreated(const char *filenm, const char *fmt=Time::defDateTimeFmt())
mDefineFactoryInClass
#define mDefineFactoryInClass(T, funcname)
Definition: factory.h:424
File::LocalFileSystemAccess::factoryKeyword
virtual const char * factoryKeyword() const
Definition: file.h:205
File::removeDir
bool removeDir(const char *)
File::LocalFileSystemAccess::createInstance
static SystemAccess * createInstance()
Definition: file.h:211
File::LocalFileSystemAccess::sFactoryDisplayName
static uiString sFactoryDisplayName()
Definition: file.h:203
File::getCurrentPath
const char * getCurrentPath()
BufferString
OD::String with its own variable length buffer. The buffer has a guaranteed minimum size...
Definition: bufstring.h:38
File::isEmpty
bool isEmpty(const char *)
File::getKbSize
int64_t getKbSize(const char *)
File::resize
bool resize(const char *, int64_t)
File::Bin
Definition: file.h:109
File::linkTarget
const char * linkTarget(const char *linkname)
Direct, first target.
File::getHomePath
const char * getHomePath()
File::isInUse
bool isInUse(const char *fnm)
File::isWritable
bool isWritable(const char *)
File::getRootPath
const char * getRootPath(const char *path)
File::ViewPars::sKeyEdit
static const char * sKeyEdit()
Definition: file.h:124
File::ViewPars
Definition: file.h:112
File::ViewPars::ViewPars
ViewPars(ViewStyle vs=Text)
Definition: file.h:116
File::ViewPars::maxnrlines_
int maxnrlines_
max nr bytes when Bin
Definition: file.h:127
File::getCanonicalPath
const char * getCanonicalPath(const char *)
File::getRelativePath
const char * getRelativePath(const char *reltodir, const char *fnm)
File::LocalFileSystemAccess
Definition: file.h:180
mClass
#define mClass(module)
Definition: commondefs.h:161
File::createLink
bool createLink(const char *from, const char *to)
File::copyDir
bool copyDir(const char *from, const char *to, uiString *errmsg=0)
File::exists
bool exists(const char *)
File::setPermissions
bool setPermissions(const char *, const char *perms, bool recursive)
File::getTimeInSeconds
int64_t getTimeInSeconds(const char *, bool modif=true)
File::linkEnd
const char * linkEnd(const char *linkname)
initClass
static void initClass()
RefMan
Definition: ptrman.h:200
Executor
Specification to enable chunkwise execution of a process.
Definition: executor.h:38
File::makeRecursiveFileList
void makeRecursiveFileList(const char *dir, BufferStringSet &filelist, bool followlinks=false)

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B. V. 2017