NLMISC::CConfigFile Class Reference

#include <config_file.h>

---

Detailed Description

CConfigFile class. Useful when you want to have a configuration file with variables. It manages integers, real (double), and string basic types. A variable can be an array of basic type. In this case, all elements of the array must have the same type.

If you setup the global callback before loading, it'll be call after the load() function.

Example:

 try
 {
        CConfigFile cf;

        // Load and parse "test.txt" file
  cf.load ("test.txt");

        // Attach a callback to the var1 variable. When the var1 will changed, this cvar1cb function will be called
        cf.setCallback ("var1", var1cb);
 
        // Get the foo variable (suppose it's a string variable)
        CConfigFile::CVar &foo = cf.getVar ("foo");
 
        // Display the content of the variable
        printf ("foo = %s\n", foo.asString ().c_str ());
 
        // Get the bar variable (suppose it's an array of int)
        CConfigFile::CVar &bar = cf.getVar ("bar");
 
        // Display the content of the all elements of the bar variable
        printf ("bar have %d elements : \n", bar.size ());
        for (int i = 0; i < bar.size (); i++)
                printf ("%d ", bar.asInt (i));
        printf("\n");
 }
 catch (EConfigFile &e)
 {
        // Something goes wrong... catch that
        printf ("%s\n", e.what ());
 }
 *

Example of config file:

 // one line comment
 / * big comment
     on more than one line * /
 
 var1 = 123;                           // var1  type:int,         value:123
 var2 = "456.25";                      // var2  type:string,      value:"456.25"
 var3 = 123.123;                       // var3  type:real,        value:123.123
 
 // the resulting type is type of the first left value
 var4 = 123.123 + 2;                   // var4  type:real,        value:125.123
 var5 = 123 + 2.1;                     // var5  type:int,         value:125
 
 var6 = (-112+1) * 3 - 14;             // var6  type:int,         value:-347
 
 var7 = var1 + 1;                      // var7  type:int,         value:124
 
 var8 = var2 + 10;                     // var8  type:string,      value:456.2510 (convert 10 into a string and concat it)
 var9 = 10.15 + var2;                  // var9  type:real,        value:466.4 (convert var2 into a real and add it)
 
 var10 = { 10.0, 51.1 };               // var10 type:realarray,   value:{10.0,51.1}
 var11 = { "str1", "str2", "str3" };   // var11 type:stringarray, value:{"str1", "str2", "str3"}
 
 var12 = { 10+var1, var1-var7 };       // var12 type:intarray,    value:{133,-1}
 *

Operators are '+', '-', '*', '/'. You can't use operators on a array variable, for example, you can't do =var12+1. If you have 2 variables with the same name, the first value will be remplaced by the second one.

Bug:

if you terminate the config file with a comment without carriage returns it'll generate an exception, add a carriage returns

Author:

Vianney Lecroart

Nevrax France

Date:

2000

Definition at line 119 of file config_file.h.

Public Member Functions
	CConfigFile ()
void	clear ()
	Clear all the variable array (including information on variable callback etc).
void	clearVars ()
	set to 0 or "" all variable in the array (but not destroy them)
void	display (CLog *log) const
	display all variables with nlinfo (debug use)
void	display () const
	display all variables with nlinfo (debug use)
bool	exists (const std::string &varName)
	Return true if the variable exists, false otherwise.
std::string	getFilename () const
	returns the config file name
uint	getNumVar () const
	Get the variable count.
CVar *	getVar (uint varId)
	Get a variable.
CVar &	getVar (const std::string &varName)
	Get a variable with the variable name.
CVar *	getVarPtr (const std::string &varName)
	Get a variable pointer with the variable name, without throwing exception. Return NULL if not found.
CVar *	insertVar (const std::string &varName, const CVar &varToCopy)
	Add a variable. If the variable already exit, return it.
void	load (const std::string &fileName)
	load and parse the file
bool	loaded ()
	Returns true if the file has been loaded.
void	reparse ()
	reload and reparse the file
void	save () const
	save the config file
void	setCallback (const std::string &VarName, void(*cb)(CConfigFile::CVar &var))
	set a callback function to a variable, it will be called when this variable is modified
void	setCallback (void(*cb)())
	set a callback function that is called when the config file is modified
virtual	~CConfigFile ()
Static Public Member Functions
void	checkConfigFiles ()
	Internal use only.
void	setTimeout (uint32 timeout)
Data Fields
std::vector< std::string >	UnknownVariables
	contains the variable names that getVar() and getVarPtr() tried to access but not present in the cfg
Private Attributes
void(*	_Callback )()
	Internal use only.
std::vector< CVar >	_Vars
	Internal use only.
std::vector< std::string >	FileNames
std::vector< uint32 >	LastModified
Static Private Attributes
std::vector< CConfigFile * > *	_ConfigFiles = NULL
uint32	_Timeout = 1000

---

Constructor & Destructor Documentation

NLMISC::CConfigFile::CConfigFile (   )  [inline]

Definition at line 202 of file config_file.h. References _Callback. : _Callback(NULL) {}

NLMISC::CConfigFile::~CConfigFile (   )  [virtual]

Definition at line 227 of file config_file.cpp. References _ConfigFiles. { if (_ConfigFiles == NULL || (*_ConfigFiles).empty ()) return; vector<CConfigFile *>::iterator it = find ((*_ConfigFiles).begin (), (*_ConfigFiles).end (), this); if (it != (*_ConfigFiles).end ()) { (*_ConfigFiles).erase (it); } if ((*_ConfigFiles).empty()) { delete _ConfigFiles; _ConfigFiles = NULL; } }

---

Member Function Documentation

void NLMISC::CConfigFile::checkConfigFiles (   )  [static]

Internal use only. Definition at line 681 of file config_file.cpp. References _ConfigFiles, _Timeout, nlassert, nlwarning, and uint. { if (_ConfigFiles == NULL) return; static time_t LastCheckTime = time (NULL); if (_Timeout > 0 && (float)(time (NULL) - LastCheckTime)*1000.0f < (float)_Timeout) return; LastCheckTime = time (NULL); bool needReparse; for (vector<CConfigFile *>::iterator it = (*_ConfigFiles).begin (); it != (*_ConfigFiles).end (); it++) { needReparse = false; nlassert ((*it)->FileNames.size() == (*it)->LastModified.size()); for (uint i = 0; i < (*it)->FileNames.size(); i++) { if ((*it)->LastModified[i] != CFile::getFileModificationDate((*it)->FileNames[i])) { needReparse = true; (*it)->LastModified[i] = CFile::getFileModificationDate((*it)->FileNames[i]); } } if (needReparse) { try { (*it)->reparse (); } catch (EConfigFile &e) { nlwarning ("CF: Exception will re-read modified config file '%s': %s", (*it)->getFilename().c_str(), e.what ()); } } } }

void NLMISC::CConfigFile::clear (   )

Clear all the variable array (including information on variable callback etc). Definition at line 722 of file config_file.cpp. { _Vars.clear (); }

void NLMISC::CConfigFile::clearVars (   )

set to 0 or "" all variable in the array (but not destroy them) Definition at line 727 of file config_file.cpp. { for (vector<CVar>::iterator it = _Vars.begin (); it != _Vars.end (); it++) { (*it).Type = CVar::T_UNKNOWN; } }

void NLMISC::CConfigFile::display (  CLog *  log  )  const

display all variables with nlinfo (debug use) Definition at line 559 of file config_file.cpp. References NLMISC::createDebug(), NLMISC::CLog::displayRaw(), NLMISC::CLog::displayRawNL(), and getFilename(). { createDebug (); log->displayRawNL ("Config file %s have %d variables and %d root config file:", getFilename().c_str(), _Vars.size(), FileNames.size()-1); log->displayRaw ("Root config files: "); for(int i = 1; i < (int)FileNames.size(); i++) { log->displayRaw (FileNames[i].c_str()); } log->displayRawNL (""); log->displayRawNL ("------------------------------------------------------"); for(int i = 0; i < (int)_Vars.size(); i++) { log->displayRaw ((_Vars[i].Callback==NULL)?" ":"CB "); log->displayRaw ((_Vars[i].Root)?"Root ":" "); if (_Vars[i].Comp) { switch (_Vars[i].Type) { case CConfigFile::CVar::T_INT: { log->displayRaw ("%-20s { ", _Vars[i].Name.c_str()); for (int it=0; it < (int)_Vars[i].IntValues.size(); it++) { log->displayRaw ("'%d' ", _Vars[i].IntValues[it]); } log->displayRawNL ("}"); break; } case CConfigFile::CVar::T_STRING: { log->displayRaw ("%-20s { ", _Vars[i].Name.c_str()); for (int st=0; st < (int)_Vars[i].StrValues.size(); st++) { log->displayRaw ("\"%s\" ", _Vars[i].StrValues[st].c_str()); } log->displayRawNL ("}"); break; } case CConfigFile::CVar::T_REAL: { log->displayRaw ("%-20s { " , _Vars[i].Name.c_str()); for (int rt=0; rt < (int)_Vars[i].RealValues.size(); rt++) { log->displayRaw ("`%f` ", _Vars[i].RealValues[rt]); } log->displayRawNL ("}"); break; } case CConfigFile::CVar::T_UNKNOWN: { log->displayRawNL ("%-20s { }" , _Vars[i].Name.c_str()); break; } default: { log->displayRawNL ("%-20s <default case comp> (%d)" , _Vars[i].Name.c_str(), _Vars[i].Type); break; } } } else { switch (_Vars[i].Type) { case CConfigFile::CVar::T_INT: log->displayRawNL ("%-20s '%d'", _Vars[i].Name.c_str(), _Vars[i].IntValues[0]); break; case CConfigFile::CVar::T_STRING: log->displayRawNL ("%-20s \"%s\"", _Vars[i].Name.c_str(), _Vars[i].StrValues[0].c_str()); break; case CConfigFile::CVar::T_REAL: log->displayRawNL ("%-20s `%f`", _Vars[i].Name.c_str(), _Vars[i].RealValues[0]); break; case CConfigFile::CVar::T_UNKNOWN: log->displayRawNL ("%-20s <Unknown>", _Vars[i].Name.c_str()); break; default: { log->displayRawNL ("%-20s <default case> (%d)" , _Vars[i].Name.c_str(), _Vars[i].Type); break; } } } } }

void NLMISC::CConfigFile::display (   )  const

display all variables with nlinfo (debug use) Definition at line 554 of file config_file.cpp. References NLMISC::InfoLog. { display (InfoLog); }

bool NLMISC::CConfigFile::exists (  const std::string &  varName  )

Return true if the variable exists, false otherwise. Definition at line 461 of file config_file.cpp. References uint. Referenced by NLNET::IService::main(). { for (uint i = 0; i < _Vars.size(); i++) { // the type could be T_UNKNOWN if we add a callback on this name but this var is not in the config file if (_Vars[i].Name == varName && (_Vars[i].Type != CVar::T_UNKNOWN || _Vars[i].Comp)) { return true; } } return false; }

std::string NLMISC::CConfigFile::getFilename (   )  const [inline]

returns the config file name Definition at line 258 of file config_file.h. Referenced by display(), getVar(), NLMISC::IVariable::init(), save(), and setCallback(). { return FileNames[0]; }

uint NLMISC::CConfigFile::getNumVar (   )  const

Get the variable count. Definition at line 735 of file config_file.cpp. References uint. { return _Vars.size (); }

CConfigFile::CVar * NLMISC::CConfigFile::getVar (  uint  varId  )

Get a variable. Definition at line 740 of file config_file.cpp. References uint. { return &(_Vars[varId]); }

CConfigFile::CVar & NLMISC::CConfigFile::getVar (  const std::string &  varName  )

Get a variable with the variable name. Definition at line 431 of file config_file.cpp. References getFilename(), and getVarPtr(). Referenced by NLNET::IService::main(), NLLIGO::CLigoConfig::read(), and NLNET::CUdpSimSock::setSimValues(). { CVar *var = getVarPtr (varName); if (var == 0) throw EUnknownVar (getFilename(), varName); else return *var; }

CConfigFile::CVar * NLMISC::CConfigFile::getVarPtr (  const std::string &  varName  )

Get a variable pointer with the variable name, without throwing exception. Return NULL if not found. Definition at line 441 of file config_file.cpp. References uint, and UnknownVariables. Referenced by getVar(), NLMISC::CWordsDictionary::init(), NLMISC::IVariable::init(), insertVar(), NLNET::IService::main(), and reparse(). { uint i; for (i = 0; i < _Vars.size(); i++) { // the type could be T_UNKNOWN if we add a callback on this name but this var is not in the config file if (_Vars[i].Name == varName && (_Vars[i].Type != CVar::T_UNKNOWN || _Vars[i].Comp)) return &(_Vars[i]); } // if not found, add it in the array if necessary for (i = 0; i < UnknownVariables.size(); i++) if(UnknownVariables[i] == varName) break; if (i == UnknownVariables.size()) UnknownVariables.push_back(varName); return NULL; }

CConfigFile::CVar * NLMISC::CConfigFile::insertVar (  const std::string &  varName, const CVar &  varToCopy )

Add a variable. If the variable already exit, return it. Definition at line 745 of file config_file.cpp. References getVarPtr(), NLMISC::CConfigFile::CVar::Name, and NLMISC::CConfigFile::CVar::Root. { // Get the var CVar *var = getVarPtr (varName); if (!var) { _Vars.push_back (varToCopy); var = &(_Vars.back ()); var->Root = false; var->Name = varName; } return var; }

void NLMISC::CConfigFile::load (  const std::string &  fileName  )

load and parse the file Definition at line 244 of file config_file.cpp. References _ConfigFiles, nlwarning, and reparse(). Referenced by NLMISC::CWordsDictionary::init(), NLNET::IService::main(), and NLLIGO::CLigoConfig::read(). { if(fileName.empty()) { nlwarning ("CF: Can't load a empty file name configfile"); return; } FileNames.clear (); FileNames.push_back (fileName); if (_ConfigFiles == NULL) { _ConfigFiles = new std::vector<CConfigFile *>; } (*CConfigFile::_ConfigFiles).push_back (this); reparse (); /* _FileName.clear (); _FileName.push_back (fileName); if (_ConfigFiles == NULL) { _ConfigFiles = new std::vector<CConfigFile *>; } (*CConfigFile::_ConfigFiles).push_back (this); reparse (); // If we find a linked config file, load it but don't overload already existant variable CVar *var = getVarPtr ("RootConfigFilename"); if (var) { string RootConfigFilename = var->asString(); nlinfo ("RootConfigFilename variable found in the '%s' config file, parse it (%s)", fileName.c_str(), RootConfigFilename.c_str()); string path = CFile::getPath(fileName); if (!path.empty()) path += "/"; path += RootConfigFilename; reparse (path.c_str()); } */ // print (); }

bool NLMISC::CConfigFile::loaded (   )

Returns true if the file has been loaded. Definition at line 292 of file config_file.cpp. { return !CConfigFile::FileNames.empty(); }

void NLMISC::CConfigFile::reparse (   )

reload and reparse the file Definition at line 297 of file config_file.cpp. References _Callback, NLMISC::CConfigFile::CVar::asString(), cf_CurrentLine, cf_ifile, cf_OverwriteExistingVariable, cfparse(), cfrestart(), NLMISC::CIFile::close(), NLMISC::CFile::fileExists(), NLMISC::CPath::getFullPath(), getVarPtr(), LoadRoot, nldebug, nlinfo, nlwarning, NLMISC::CIFile::open(), and NLMISC::CPath::standardizePath(). Referenced by load(). { if (FileNames.empty()) { nlwarning ("CF: Can't reparse config file because file name is empty"); return; } string fn = FileNames[0]; FileNames.clear (); LastModified.clear (); // clearVars (); while (!fn.empty()) { fn = NLMISC::CPath::getFullPath(fn, false); nldebug ("CF: Adding config file '%s' in the config file", fn.c_str()); FileNames.push_back (fn); LastModified.push_back (CFile::getFileModificationDate(fn)); if (cf_ifile.open (fn)) { cfrestart (NULL); cf_OverwriteExistingVariable = (FileNames.size()==1); LoadRoot = (FileNames.size()>1); bool parsingOK = (cfparse (&(_Vars)) == 0); cf_ifile.close(); if (!parsingOK) { nlwarning ("CF: Parsing error in file %s line %d", fn.c_str(), cf_CurrentLine); throw EParseError (fn, cf_CurrentLine); } } else { nlwarning ("CF: Config file '%s' not found in the path '%s'", fn.c_str(), CPath::getCurrentPath().c_str()); throw EFileNotFound (fn); } cf_ifile.close (); // If we find a linked config file, load it but don't overload already existant variable CVar *var = getVarPtr ("RootConfigFilename"); if (var) { string RootConfigFilename = var->asString(); if (!NLMISC::CFile::fileExists(RootConfigFilename)) { // file is not found, try with the path of the master cfg string path = NLMISC::CPath::standardizePath (NLMISC::CFile::getPath(FileNames[0])); RootConfigFilename = path + RootConfigFilename; } RootConfigFilename = NLMISC::CPath::getFullPath(RootConfigFilename, false); if (RootConfigFilename != fn) { nlinfo ("CF: RootConfigFilename variable found in the '%s' config file, parse the root config file '%s'", fn.c_str(), RootConfigFilename.c_str()); fn = RootConfigFilename; } else fn.clear (); } else fn.clear (); } if (_Callback != NULL) _Callback(); /* if (filename == NULL) { _LastModified = getLastModified (); nlassert (!_FileName.empty()); if (cf_ifile.open (_FileName[0])) { // if we clear all the array, we'll lost the callback on variable and all information // _Vars.clear(); cfrestart (NULL); cf_OverwriteExistingVariable = true; LoadRoot = false; bool parsingOK = (cfparse (&(_Vars)) == 0); cf_ifile.close(); if (!parsingOK) { nlwarning ("Parsing error in file %s line %d", _FileName.c_str(), cf_CurrentLine); throw EParseError (_FileName, cf_CurrentLine); } } else { nlwarning ("ConfigFile '%s' not found in the path '%s'", _FileName.c_str(), CPath::getCurrentPath().c_str()); throw EFileNotFound (_FileName); } } else { nlassert (strlen(filename)>0); // load external config filename, don't overwrite existant variable if (cf_ifile.open (filename)) { cfrestart (NULL); cf_OverwriteExistingVariable = false; LoadRoot = true; bool parsingOK = (cfparse (&(_Vars)) == 0); cf_ifile.close (); if (!parsingOK) { nlwarning ("Parsing error in file %s line %d", filename, cf_CurrentLine); throw EParseError (filename, cf_CurrentLine); } } else { nlwarning ("RootConfigFilename '%s' not found", _FileName.c_str()); } } if (callingCallback) { if (_Callback != NULL) _Callback(); } */ }

void NLMISC::CConfigFile::save (   )  const

save the config file Definition at line 474 of file config_file.cpp. References getFilename(), and nlwarning. { FILE *fp = fopen (getFilename().c_str (), "w"); if (fp == NULL) { nlwarning ("CF: Couldn't create %s file", getFilename().c_str ()); return; } for(int i = 0; i < (int)_Vars.size(); i++) { // Not a root value if (!_Vars[i].Root) { if (_Vars[i].Comp) { fprintf(fp, "%-20s = {", _Vars[i].Name.c_str()); switch (_Vars[i].Type) { case CConfigFile::CVar::T_INT: { for (int it=0; it < (int)_Vars[i].IntValues.size(); it++) { if (it%_Vars[i].SaveWrap == 0) { fprintf(fp, "\n\t"); } fprintf(fp, "%d%s", _Vars[i].IntValues[it], it<(int)_Vars[i].IntValues.size()-1?", ":" "); } break; } case CConfigFile::CVar::T_STRING: { for (int st=0; st < (int)_Vars[i].StrValues.size(); st++) { if (st%_Vars[i].SaveWrap == 0) { fprintf(fp, "\n\t"); } fprintf(fp, "\"%s\"%s", _Vars[i].StrValues[st].c_str(), st<(int)_Vars[i].StrValues.size()-1?", ":" "); } break; } case CConfigFile::CVar::T_REAL: { for (int rt=0; rt < (int)_Vars[i].RealValues.size(); rt++) { if (rt%_Vars[i].SaveWrap == 0) { fprintf(fp, "\n\t"); } fprintf(fp, "%.10f%s", _Vars[i].RealValues[rt], rt<(int)_Vars[i].RealValues.size()-1?", ":" "); } break; } default: break; } fprintf(fp, "\n};\n"); } else { switch (_Vars[i].Type) { case CConfigFile::CVar::T_INT: fprintf(fp, "%-20s = %d;\n", _Vars[i].Name.c_str(), _Vars[i].IntValues[0]); break; case CConfigFile::CVar::T_STRING: fprintf(fp, "%-20s = \"%s\";\n", _Vars[i].Name.c_str(), _Vars[i].StrValues[0].c_str()); break; case CConfigFile::CVar::T_REAL: fprintf(fp, "%-20s = %.10f;\n", _Vars[i].Name.c_str(), _Vars[i].RealValues[0]); break; default: break; } } } } fclose (fp); }

void NLMISC::CConfigFile::setCallback (  const std::string &  VarName, void(*  cb)(CConfigFile::CVar &var) )

set a callback function to a variable, it will be called when this variable is modified Definition at line 653 of file config_file.cpp. References NLMISC::CConfigFile::CVar::Callback, NLMISC::CConfigFile::CVar::Comp, getFilename(), NLMISC::CConfigFile::CVar::Name, nlinfo, and NLMISC::CConfigFile::CVar::Type. { for (vector<CVar>::iterator it = _Vars.begin (); it != _Vars.end (); it++) { if (VarName == (*it).Name) { (*it).Callback = cb; nlinfo ("CF: Setting callback when the variable '%s' on the file '%s' is modified externaly", VarName.c_str(), getFilename().c_str()); return; } } // VarName doesn't exist, add it now for the future CVar Var; Var.Name = VarName; Var.Callback = cb; Var.Type = CVar::T_UNKNOWN; Var.Comp = false; _Vars.push_back (Var); nlinfo ("CF: Setting callback when the variable '%s' on the file '%s' is modified externaly (actually unknown)", VarName.c_str(), getFilename().c_str()); }

void NLMISC::CConfigFile::setCallback (  void(*  cb)()  )

set a callback function that is called when the config file is modified Definition at line 647 of file config_file.cpp. References _Callback, getFilename(), and nlinfo. Referenced by NLMISC::IVariable::init(), NLNET::IService::main(), and NLNET::CUdpSimSock::setSimValues(). { _Callback = cb; nlinfo ("CF: Setting callback when the file '%s' is modified externaly", FileNames.empty()?"":getFilename().c_str()); }

void NLMISC::CConfigFile::setTimeout (  uint32  timeout  )  [static]

set the time between 2 file checking (default value is 1 second) Parameters: timeout  time in millisecond, if timeout=0, the check will be made each "frame" Definition at line 717 of file config_file.cpp. References _Timeout, and uint32. { _Timeout = timeout; }

---

Field Documentation

void(* NLMISC::CConfigFile::_Callback)() [private]

Internal use only. Referenced by CConfigFile(), reparse(), and setCallback().

vector< CConfigFile * > * NLMISC::CConfigFile::_ConfigFiles = NULL [static, private]

Definition at line 677 of file config_file.cpp. Referenced by checkConfigFiles(), load(), and ~CConfigFile().

uint32 NLMISC::CConfigFile::_Timeout = 1000 [static, private]

Definition at line 679 of file config_file.cpp. Referenced by checkConfigFiles(), and setTimeout().

std::vector<CVar> NLMISC::CConfigFile::_Vars [private]

Internal use only. Definition at line 273 of file config_file.h.

std::vector<std::string> NLMISC::CConfigFile::FileNames [private]

Definition at line 280 of file config_file.h.

std::vector<uint32> NLMISC::CConfigFile::LastModified [private]

Definition at line 281 of file config_file.h.

std::vector<std::string> NLMISC::CConfigFile::UnknownVariables

contains the variable names that getVar() and getVarPtr() tried to access but not present in the cfg Definition at line 255 of file config_file.h. Referenced by getVarPtr().

---

The documentation for this class was generated from the following files:

• config_file.h
• config_file.cpp

---