env.H

Go to the documentation of this file.

/*
 *  This file is part of the Home2L project.
 *
 *  (C) 2015-2021 Gundolf Kiefer
 *
 *  Home2L is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Home2L is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Home2L. If not, see <https://www.gnu.org/licenses/>.
 *
 */
 
 
#ifndef _ENV_
#define _ENV_
 
// This file is SWIG-readable and part of the Python library.
 
 
#ifdef SWIG
%pythoncode %{
## @defgroup env Environment
## @brief Access configuration parameters and query environment properties.
##
## More detailed information on these functions can be found in the
## [*C/C++ API documentation*](../home2l-api_c/group__env.html).
## @{
%}
#endif
 
 
#ifndef SWIG
 
#include "base.H"
 
#include <stdio.h>
 
#endif // SWIG
 
 
 
// ********************** Global settings **************************************
 
 
 
 
#define HOME2L_USER "home2l"    
 
 
 
 
 
 
// ***************** Basic Environment Information and Helpers *****************
 
 
 
 
 
const char *EnvBuildOS ();        
const char *EnvBuildArch ();      
 
const char *EnvMachineName ();    
 
const char *EnvExecPathName ();
const char *EnvExecName ();       
 
const char *EnvInstanceName ();
 
const char *EnvDroidId ();        
 
int EnvPid ();                    
bool EnvHaveTerminal ();          
 
void EnvReadIniFile (const char *fileName, CDictCompact<CString> *map);
 
 
 
 
 
const char *EnvHome2lRoot ();     
const char *EnvHome2lEtc ();      
const char *EnvHome2lVar ();      
const char *EnvHome2lTmp ();      
 
#ifndef SWIG
 
const char *EnvGetHome2lRootPath (CString *ret, const char *relOrAbsPath);
const char *EnvGetHome2lEtcPath (CString *ret, const char *relOrAbsPath);
const char *EnvGetHome2lVarPath (CString *ret, const char *relOrAbsPath);
const char *EnvGetHome2lTmpPath (CString *ret, const char *relOrAbsPath);
 
#else // SWIG
 
%feature("docstring") EnvGetHome2lRootPath "Return an absolute path name in the root domain.\n\n" \
  "Path starting with '/' are considered already absolute and are\n" \
  "returned unchanged, but normalized.\n"
%feature("docstring") EnvGetHome2lEtcPath "Return an absolute path name in the 'etc' domain.\n\n" \
  "Path starting with '/' are considered already absolute and are\n" \
  "returned unchanged, but normalized.\n"
%feature("docstring") EnvGetHome2lVarPath "Return an absolute path name in the 'var' domain.\n\n" \
  "Path starting with '/' are considered already absolute and are\n" \
  "returned unchanged, but normalized.\n"
%feature("docstring") EnvGetHome2lTmpPath "Return an absolute path name in the 'tmp' domain.\n\n" \
  "Path starting with '/' are considered already absolute and are\n" \
  "returned unchanged, but normalized.\n"
 
%newobject EnvGetHome2lRootPath (const char *);
%newobject EnvGetHome2lEtcPath (const char *);
%newobject EnvGetHome2lVarPath (const char *);
%newobject EnvGetHome2lTmpPath (const char *);
%inline %{
static inline const char *EnvGetHome2lRootPath (const char *relOrAbsPath) { CString s; EnvGetHome2lRootPath (&s, relOrAbsPath); return s.Disown (); }
static inline const char *EnvGetHome2lEtcPath (const char *relOrAbsPath) { CString s; EnvGetHome2lEtcPath (&s, relOrAbsPath); return s.Disown (); }
static inline const char *EnvGetHome2lVarPath (const char *relOrAbsPath) { CString s; EnvGetHome2lVarPath (&s, relOrAbsPath); return s.Disown (); }
static inline const char *EnvGetHome2lTmpPath (const char *relOrAbsPath) { CString s; EnvGetHome2lTmpPath (&s, relOrAbsPath); return s.Disown (); }
%} // inline
 
#endif // SWIG
 
bool EnvMkVarDir (const char *relOrAbsPath);
bool EnvMkTmpDir (const char *relOrAbsPath);
 
 
 
 
 
bool EnvNetResolve (const char *hostAndPort, CString *retHost, int *retPort = NULL, int defaultPort = 0, bool warn = true);
 
 
 
 
float EnvLocationLatitudeN ();
float EnvLocationLongitudeE ();
 
 
 
 
 
 
 
 
 
 
 
 
// ********************** Environment dictionary *****************************
 
 
 
 
void EnvInit (int argc, char **argv, const char *specOptionsUsage = NULL, const char *instanceName = NULL, bool noBanner = false);
void EnvPrintBanner ();
void EnvDone ();
 
 
void EnvEnablePersistence (bool writeThrough = true, const char *_varFileName = NULL);
 
void EnvFlush ();   
 
 
 
 
 
 
 
 
#ifdef SWIG
%feature("docstring") EnvGet "Get a Home2L configuration variable from the environment."
#endif
const char *EnvGet (const char *key);
 
const char *EnvPut (const char *key, const char *value);
const char *EnvPut (const char *key, int value);
static inline void EnvDel (const char *key) { EnvPut (key, (const char *) NULL); }
 
 
 
#ifndef SWIG
 
 
bool EnvGetString (const char *key, const char **ret, bool warnIfMissing = false);
const char *EnvGetString (const char *key, const char *defaultVal, bool warnIfMissing = false);
static inline const char *EnvGetString (const char *key, bool warnIfMissing) { return EnvGetString (key, (const char *) NULL, warnIfMissing); }
static inline const char *EnvGetString (const char *key) { return EnvGet (key); }
 
bool EnvGetPath (const char *key, const char **ret, const char *path = NULL, bool warnIfMissing = false);
const char *EnvGetPath (const char *key, const char *path = NULL, bool warnIfMissing = false);
bool EnvGetHostAndPort (const char *key, CString *retHost, int *retPort = NULL, int defaultPort = 0, bool warnIfMissing = false);
static inline bool EnvGetHost (const char *key, CString *retHost, bool warnIfMissing = false) { return EnvGetHostAndPort (key, retHost, NULL, 0, warnIfMissing); }
 
 
bool EnvGetInt (const char *key, int *ret, bool warnIfMissing = false);                  
int EnvGetInt (const char *key, int defaultVal = 0, bool warnIfMissing = false);         
 
bool EnvGetFloat (const char *key, float *ret, bool warnIfMissing = false);              
float EnvGetFloat (const char *key, float defaultVal = 0.0, bool warnIfMissing = false); 
 
bool EnvGetBool (const char *key, bool *ret, bool warnIfMissing = false);                
bool EnvGetBool (const char *key, bool defaultVal = false, bool warnIfMissing = false);  
 
 
#endif // SWIG
 
 
 
 
#ifndef SWIG
 
void EnvGetPrefixInterval (const char *prefix, int *retIdx0, int *retIdx1);
const char *EnvGetKey (int idx);
const char *EnvGetVal (int idx);
 
const CDictRaw *EnvGetKeySet ();
 
#endif // SWIG
 
 
 
 
 
 
 
// ************ Parameter declaration with automatic documentation *************
 
 
enum EEnvParaType {
  eptString = 0,
  eptPath,
  eptInt,
  eptFloat,
  eptBool
};
 
 
class CEnvPara {
  public:
    CEnvPara (const char *_key, EEnvParaType _type, void *_pVar);
 
    static void GetAll (bool withVarKeys = true);
 
  protected:
    const char *key;
    EEnvParaType type;
    void *pVar;
 
    CEnvPara *next;
    static CEnvPara *first;
};
 
 
#define ENV_PARA_STRING(key,varName,varDefault) const char *varName = varDefault; CEnvPara varName##PreInit (key, eptString, &varName); const char *varName##Key = key;
#define ENV_PARA_PATH(key,varName,varDefault) const char *varName = varDefault; CEnvPara varName##PreInit (key, eptPath, &varName); const char *varName##Key = key;
#define ENV_PARA_INT(key,varName,varDefault) int varName = varDefault; CEnvPara varName##PreInit (key, eptInt, &varName); const char *varName##Key = key;
#define ENV_PARA_FLOAT(key,varName,varDefault) float varName = varDefault; CEnvPara varName##PreInit (key, eptFloat, &varName); const char *varName##Key = key;
#define ENV_PARA_BOOL(key,varName,varDefault) bool varName = varDefault; CEnvPara varName##PreInit (key, eptBool, &varName); const char *varName##Key = key;
 
#define ENV_PARA_VAR(key,varType,varName,varDefault) varType varName = varDefault; const char *varName##Key = key;
 
#define ENV_PARA_NOVAR(key,varType,varName,varDefault) const char *varName##Key = key;
 
#define ENV_PARA_SPECIAL(keyPattern, varType, varDefault)
 
 
 
 
#ifdef SWIG
%pythoncode %{
## @}
%}
#endif
 
 
#endif