oddirs.h

Go to the documentation of this file.

#ifndef oddirs_h
#define oddirs_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Bril
 Date:          Aug 2005
 RCS:           $Id$
________________________________________________________________________

OpendTect directories.

Beware that all functions may return a pointer to *the same* static buffer!

-*/

#ifndef gendefs_h
#include "basicmod.h"
#include "gendefs.h"
#endif

extern "C" {

/* Functions delivering files/directies in the 'survey data' scope */

mGlobal(Basic) const char* GetBaseDataDir(void);
mGlobal(Basic) const char* GetDataDir(void);
mGlobal(Basic) const char* GetProcFileName(const char*);
/* Functions delivering files/directies in the 'sytem' scope */

mGlobal(Basic) const char* GetSoftwareDir(bool acceptnone);
mGlobal(Basic) const char* GetBinSubDir(void);
mGlobal(Basic) const char* GetApplSetupDir(void);
typedef enum
{
    ODSetupLoc_ApplSetupOnly,
    ODSetupLoc_ApplSetupPref, /* Usual choice for GetSetupDataFileName */
    ODSetupLoc_SWDirPref,
    ODSetupLoc_SWDirOnly
} ODSetupLocType;

mGlobal(Basic) const char* GetSetupDataFileDir(ODSetupLocType,bool acceptnone);
#define mGetApplSetupDataDir() GetSetupDataFileDir(ODSetupLoc_ApplSetupOnly,0)
#define mGetSWDirDataDir() GetSetupDataFileDir(ODSetupLoc_SWDirOnly,0)

mGlobal(Basic) const char* GetSetupDataFileName(ODSetupLocType,const char*,
                                         bool acceptnone);
#define mGetSetupFileName(x) GetSetupDataFileName(ODSetupLoc_ApplSetupPref,x,0)

mGlobal(Basic) const char* GetPlfSubDir(void);
mGlobal(Basic) const char* GetExecPlfDir(void);
mGlobal(Basic) const char* GetScriptDir(void);
mGlobal(Basic) const char* GetLibPlfDir(void);
mGlobal(Basic) inline const char* GetBinPlfDir(void)
{ return GetExecPlfDir(); }

mGlobal(Basic) const char* GetDocFileDir(const char* filedir);
#define mGetUserDocDir()        GetDocFileDir("userdoc")
#define mGetProgrammerDocDir()  GetDocFileDir("Programmer")
#define mGetSysAdmDocDir()      GetDocFileDir("SysAdm")


mGlobal(Basic) const char* GetExecScript(int remote);
#define         mGetExecScript()        GetExecScript(0)

mGlobal(Basic) const char* GetODExternalScript();
/* Location of od_external script to launch commands free of any OpendTect
   environment
*/

mGlobal(Basic) const char* GetSoftwareUser(void);
mGlobal(Basic) const char* GetUserNm(void);
    /* Functions delivering files/directies in the 'user-specific' scope */
mGlobal(Basic) const char* GetPersonalDir(void);
mGlobal(Basic) const char* GetSettingsDir(void);
mGlobal(Basic) const char* GetSettingsFileName(const char*);
mGlobal(Basic) const char* GetScriptsDir(const char*);


} // extern "C"

#endif