OpendTect  6.3
oddirs.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: A.H. Bril
8  Date: Aug 2005
9 ________________________________________________________________________
10 
11 OpendTect directories.
12 
13 Beware that all functions may return a pointer to *the same* static buffer!
14 
15 -*/
16 
17 #ifndef gendefs_h
18 #include "basicmod.h"
19 #include "gendefs.h"
20 #endif
21 
22 extern "C" {
23 
24 /* Functions delivering files/directies in the 'survey data' scope */
25 
26 mGlobal(Basic) const char* GetBaseDataDir(void);
29 mGlobal(Basic) const char* GetDataDir(void);
32 mGlobal(Basic) const char* GetProcFileName(const char*);
35 mGlobal(Basic) const char* GetLastSurveyFileName(void);
39 /* Functions delivering files/directies in the 'sytem' scope */
40 
41 mGlobal(Basic) const char* GetSoftwareDir(bool acceptnone);
52 mGlobal(Basic) const char* GetBinSubDir(void);
55 mGlobal(Basic) const char* GetApplSetupDir(void);
63 typedef enum
64 {
65  ODSetupLoc_ApplSetupOnly,
66  ODSetupLoc_ApplSetupPref, /* Usual choice for GetSetupDataFileName */
67  ODSetupLoc_SWDirPref,
68  ODSetupLoc_SWDirOnly
69 } ODSetupLocType;
70 
71 mGlobal(Basic) const char* GetSetupDataFileDir(ODSetupLocType,bool acceptnone);
76 #define mGetApplSetupDataDir() GetSetupDataFileDir(ODSetupLoc_ApplSetupOnly,0)
77 #define mGetSWDirDataDir() GetSetupDataFileDir(ODSetupLoc_SWDirOnly,0)
78 
79 mGlobal(Basic) const char* GetSetupDataFileName(ODSetupLocType,const char*,
80  bool acceptnone);
89 #define mGetSetupFileName(x) GetSetupDataFileName(ODSetupLoc_ApplSetupPref,x,0)
90 
93 mGlobal(Basic) const char* GetPlfSubDir(void);
101 mGlobal(Basic) const char* GetExecPlfDir(void);
108 mGlobal(Basic) const char* GetScriptDir(void);
115 mGlobal(Basic) const char* GetLibPlfDir(void);
122 mGlobal(Basic) inline mDeprecated const char* GetBinPlfDir(void)
123 { return GetExecPlfDir(); }
125 
126 mGlobal(Basic) const char* GetDocFileDir(const char* filedir);
128 #define mGetUserDocDir() GetDocFileDir("userdoc")
129 #define mGetProgrammerDocDir() GetDocFileDir("Programmer")
130 #define mGetSysAdmDocDir() GetDocFileDir("SysAdm")
131 
132 
133 mGlobal(Basic) const char* GetExecScript(int remote);
138 #define mGetExecScript() GetExecScript(0)
139 
140 mGlobal(Basic) const char* GetSoftwareUser(void);
148 mGlobal(Basic) const char* GetUserNm(void);
152  /* Functions delivering files/directies in the 'user-specific' scope */
153 mGlobal(Basic) const char* GetPersonalDir(void);
174 mGlobal(Basic) const char* GetSettingsDir(void);
181 mGlobal(Basic) const char* GetSettingsFileName(const char*);
185 mGlobal(Basic) const char* GetScriptsDir(const char*);
186 
187 
188 } // extern "C"
GetSetupDataFileName
const char * GetSetupDataFileName(ODSetupLocType, const char *, bool acceptnone)
ODSetupLoc_SWDirOnly
Definition: oddirs.h:68
GetSetupDataFileDir
const char * GetSetupDataFileDir(ODSetupLocType, bool acceptnone)
GetBaseDataDir
const char * GetBaseDataDir(void)
mGlobal
#define mGlobal(module)
Definition: commondefs.h:160
GetDataDir
const char * GetDataDir(void)
GetExecScript
const char * GetExecScript(int remote)
GetExecPlfDir
const char * GetExecPlfDir(void)
GetBinPlfDir
const char * GetBinPlfDir(void)
Old don't use.
Definition: oddirs.h:123
GetScriptsDir
const char * GetScriptsDir(const char *)
GetPlfSubDir
const char * GetPlfSubDir(void)
GetSettingsDir
const char * GetSettingsDir(void)
ODSetupLocType
ODSetupLocType
Definition: oddirs.h:63
GetSettingsFileName
const char * GetSettingsFileName(const char *)
GetApplSetupDir
const char * GetApplSetupDir(void)
GetScriptDir
const char * GetScriptDir(void)
ODSetupLoc_SWDirPref
Definition: oddirs.h:67
GetBinSubDir
const char * GetBinSubDir(void)
ODSetupLoc_ApplSetupOnly
Definition: oddirs.h:65
GetUserNm
const char * GetUserNm(void)
mDeprecated
#define mDeprecated
Definition: plfdefs.h:213
GetLastSurveyFileName
const char * GetLastSurveyFileName(void)
GetDocFileDir
const char * GetDocFileDir(const char *filedir)
GetSoftwareUser
const char * GetSoftwareUser(void)
GetPersonalDir
const char * GetPersonalDir(void)
ODSetupLoc_ApplSetupPref
Definition: oddirs.h:66
GetProcFileName
const char * GetProcFileName(const char *)
GetSoftwareDir
const char * GetSoftwareDir(bool acceptnone)
GetLibPlfDir
const char * GetLibPlfDir(void)

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