OpendTect  6.6
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  RCS: $Id$
10 ________________________________________________________________________
11 
12 OpendTect directories.
13 
14 Beware that all functions may return a pointer to *the same* static buffer!
15 
16 -*/
17 
18 #ifndef gendefs_h
19 #include "basicmod.h"
20 #include "gendefs.h"
21 #endif
22 
23 extern "C" {
24 
25 /* Functions delivering files/directies in the 'survey data' scope */
26 
27 mGlobal(Basic) const char* GetBaseDataDir(void);
30 mGlobal(Basic) const char* GetDataDir(void);
33 mGlobal(Basic) const char* GetProcFileName(const char*);
37 /* Functions delivering files/directies in the 'sytem' scope */
38 
39 mGlobal(Basic) const char* GetSoftwareDir(bool acceptnone);
50 mGlobal(Basic) const char* GetBinSubDir(void);
53 mGlobal(Basic) const char* GetApplSetupDir(void);
61 typedef enum
62 {
63  ODSetupLoc_ApplSetupOnly,
64  ODSetupLoc_ApplSetupPref, /* Usual choice for GetSetupDataFileName */
65  ODSetupLoc_SWDirPref,
66  ODSetupLoc_SWDirOnly
67 } ODSetupLocType;
68 
69 mGlobal(Basic) const char* GetSetupDataFileDir(ODSetupLocType,bool acceptnone);
74 #define mGetApplSetupDataDir() GetSetupDataFileDir(ODSetupLoc_ApplSetupOnly,0)
75 #define mGetSWDirDataDir() GetSetupDataFileDir(ODSetupLoc_SWDirOnly,0)
76 
77 mGlobal(Basic) const char* GetSetupDataFileName(ODSetupLocType,const char*,
78  bool acceptnone);
87 #define mGetSetupFileName(x) GetSetupDataFileName(ODSetupLoc_ApplSetupPref,x,0)
88 
91 mGlobal(Basic) const char* GetPlfSubDir(void);
99 mGlobal(Basic) const char* GetExecPlfDir(void);
106 mGlobal(Basic) const char* GetScriptDir(void);
113 mGlobal(Basic) const char* GetShellScript(const char*);
116 mGlobal(Basic) const char* GetPythonScript(const char*);
119 mGlobal(Basic) const char* GetLibPlfDir(void);
126 mGlobal(Basic) inline const char* GetBinPlfDir(void)
127 { return GetExecPlfDir(); }
129 
130 mGlobal(Basic) const char* GetDocFileDir(const char* filedir);
132 #define mGetUserDocDir() GetDocFileDir("userdoc")
133 #define mGetProgrammerDocDir() GetDocFileDir("Programmer")
134 #define mGetSysAdmDocDir() GetDocFileDir("SysAdm")
135 
136 
137 mGlobal(Basic) const char* GetExecScript(int remote);
142 #define mGetExecScript() GetExecScript(0)
143 
144 mGlobal(Basic) const char* GetODExternalScript();
145 /* Location of od_external script to launch commands free of any OpendTect
146  environment
147 */
148 
149 mGlobal(Basic) const char* GetSoftwareUser(void);
157 mGlobal(Basic) const char* GetUserNm(void);
161  /* Functions delivering files/directies in the 'user-specific' scope */
162 mGlobal(Basic) const char* GetPersonalDir(void);
183 mGlobal(Basic) const char* GetSettingsDir(void);
190 mGlobal(Basic) const char* GetSettingsFileName(const char*);
194 mGlobal(Basic) const char* GetScriptsDir(const char*);
195 mGlobal(Basic) const char* GetSurveyExportDir();
196 mGlobal(Basic) const char* GetSurveyPicturesDir();
197 mGlobal(Basic) const char* GetSurveyTempDir();
198 
199 mGlobal(Basic) const char* GetImportFromDir();
200 mGlobal(Basic) void SetImportFromDir(const char*);
201 mGlobal(Basic) const char* GetExportToDir();
202 mGlobal(Basic) void SetExportToDir(const char*);
203 
204 
205 } // extern "C"
206 
GetODExternalScript
const char * GetODExternalScript()
GetSoftwareUser
const char * GetSoftwareUser(void)
ODSetupLoc_ApplSetupOnly
@ ODSetupLoc_ApplSetupOnly
Definition: oddirs.h:63
GetBinSubDir
const char * GetBinSubDir(void)
GetBinPlfDir
const char * GetBinPlfDir(void)
Old don't use.
Definition: oddirs.h:127
mGlobal
#define mGlobal(module)
Definition: commondefs.h:180
GetExportToDir
const char * GetExportToDir()
SetImportFromDir
void SetImportFromDir(const char *)
GetScriptDir
const char * GetScriptDir(void)
GetPersonalDir
const char * GetPersonalDir(void)
GetLibPlfDir
const char * GetLibPlfDir(void)
ODSetupLoc_ApplSetupPref
@ ODSetupLoc_ApplSetupPref
Definition: oddirs.h:64
GetSurveyTempDir
const char * GetSurveyTempDir()
GetDocFileDir
const char * GetDocFileDir(const char *filedir)
ODSetupLoc_SWDirOnly
@ ODSetupLoc_SWDirOnly
Definition: oddirs.h:66
GetUserNm
const char * GetUserNm(void)
GetSetupDataFileDir
const char * GetSetupDataFileDir(ODSetupLocType, bool acceptnone)
gendefs.h
GetExecScript
const char * GetExecScript(int remote)
GetImportFromDir
const char * GetImportFromDir()
GetShellScript
const char * GetShellScript(const char *)
GetSetupDataFileName
const char * GetSetupDataFileName(ODSetupLocType, const char *, bool acceptnone)
GetSettingsDir
const char * GetSettingsDir(void)
GetProcFileName
const char * GetProcFileName(const char *)
GetDataDir
const char * GetDataDir(void)
GetApplSetupDir
const char * GetApplSetupDir(void)
ODSetupLoc_SWDirPref
@ ODSetupLoc_SWDirPref
Definition: oddirs.h:65
GetSoftwareDir
const char * GetSoftwareDir(bool acceptnone)
GetExecPlfDir
const char * GetExecPlfDir(void)
GetBaseDataDir
const char * GetBaseDataDir(void)
ODSetupLocType
ODSetupLocType
Definition: oddirs.h:62
GetSettingsFileName
const char * GetSettingsFileName(const char *)
GetPythonScript
const char * GetPythonScript(const char *)
SetExportToDir
void SetExportToDir(const char *)
GetSurveyExportDir
const char * GetSurveyExportDir()
GetSurveyPicturesDir
const char * GetSurveyPicturesDir()
GetPlfSubDir
const char * GetPlfSubDir(void)
GetScriptsDir
const char * GetScriptsDir(const char *)

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