A class to provide standard parameter entry facilities. More...

#include <configurator.h>

Public Member Functions
void	DumpPublicSymbols (const char *a_dumpfile, CfgSecureLevel a_level)

void	DumpAllSymbolsAndExit (const char *a_dumpfile)

bool	ReadSymbols (const char *a_cfgfile)

	Configurator (void)

	~Configurator (void)

bool	Register (CfgBase a_cfgval, const char a_key)

Private Member Functions
void	ParseCfgLine (char *a_line)

void	SetCfgInt (char a_key, char a_val)

void	SetCfgFloat (char a_key, char a_val)

void	SetCfgBool (char a_key, char a_val)

void	SetCfgStr (char a_key, char a_val)

bool	LastDoubleQuote (char *a_rest_of_line)

bool	SetCfgGatekeeper (const char a_method, const char a_key, CfgSecureLevel a_level)

void	ShowIdType (unsigned int a_i)

char *	ExtractString (char *a_line)

void	DumpSymbols (const char *a_dumpfile, CfgSecureLevel a_level)

Private Attributes
map< string, unsigned int >	CfgI

vector< CfgBase * >	CfgVals

unsigned int	m_lineno

Detailed Description

A class to provide standard parameter entry facilities.

Definition at line 148 of file configurator.h.

Constructor & Destructor Documentation

Configurator::Configurator ( void )

Definition at line 133 of file configurator.cpp.

References m_lineno.

Referenced by CfgBase::CfgBase().

 {
     m_lineno = 0;
 }

Configurator::~Configurator ( void )

Definition at line 140 of file configurator.cpp.

 {
   ;
 }

Member Function Documentation

void Configurator::DumpAllSymbolsAndExit ( const char * a_dumpfile )

Definition at line 566 of file configurator.cpp.

References CFG_PRIVATE, and DumpSymbols().

Referenced by Landscape::DumpAllSymbolsAndExit().

 {
   DumpSymbols( a_dumpfile, CFG_PRIVATE );
   exit(1);
 }

void Configurator::DumpPublicSymbols	(	const char *	a_dumpfile,
		CfgSecureLevel	a_level
	)

Definition at line 555 of file configurator.cpp.

References CFG_PUBLIC, and DumpSymbols().

Referenced by Landscape::DumpPublicSymbols().

 {
   if ( a_level > CFG_PUBLIC ) {
     a_level = CFG_PUBLIC;
   }
   DumpSymbols( a_dumpfile, a_level );
 }

void Configurator::DumpSymbols	(	const char *	a_dumpfile,
		CfgSecureLevel	a_level
	)

private

Definition at line 573 of file configurator.cpp.

References CFG_BOOL, CFG_FLOAT, CFG_INT, CFG_MAX_LINE_LENGTH, CFG_STRING, CfgI, CfgSecureStrings, CfgTypeStrings, CfgVals, g_msg, CfgBase::getlevel(), CfgStr::gettype(), CfgInt::value(), CfgFloat::value(), CfgBool::value(), CfgStr::value(), MapErrorMsg::Warn(), and WARN_FILE.

Referenced by DumpAllSymbolsAndExit(), and DumpPublicSymbols().

 {
   FILE *l_dumpfile;
   char l_oprefix[ CFG_MAX_LINE_LENGTH ] = {""};
   char l_nprefix[ CFG_MAX_LINE_LENGTH ];
   const char* l_id;
   l_dumpfile=fopen( a_dumpfile, "w" );
   if (!l_dumpfile) {
     g_msg->Warn( WARN_FILE, "Configurator::DumpSymbols() "
          "Unable to open file for writing:",
          a_dumpfile );
     exit(1);
   }
 
   typedef map<string,unsigned int>::const_iterator MI;
 
   for ( MI ii = CfgI.begin(); ii != CfgI.end(); ii++ ) {
     unsigned int i = ii->second;
 
     // Skip 'secret' variables.
     if ( CfgVals[ i ]->getlevel() > a_level ) {
       continue;
     }
 
     // Weird hack to separate different groups of
     // configuration names.
     string rubbish=CfgVals[ i ]->getkey();
     l_id=rubbish.c_str();
     //l_id = CfgVals[ i ]->getkey().c_str();
     sscanf( l_id, "%[A-Z]", l_nprefix );
     if ( strcmp( l_oprefix, l_nprefix ) != 0 ) {
       fprintf( l_dumpfile, "\n" );
       strcpy( l_oprefix, l_nprefix );
     }
 
     fprintf( l_dumpfile, "%s (%s) = ",
          l_id,
          CfgTypeStrings[ CfgVals[ i ]->gettype() ]
          );
 
     switch( CfgVals[ i ]->gettype() ) {
     case CFG_INT:
       {
     CfgInt* l_p = dynamic_cast<CfgInt*>(CfgVals[ i ]);
     fprintf( l_dumpfile, "%d", l_p->value() );
     break;
       }
     case CFG_FLOAT:
       {
     CfgFloat* l_p = dynamic_cast<CfgFloat*>(CfgVals[ i ]);
     fprintf( l_dumpfile, "%f", l_p->value() );
     break;
       }
     case CFG_BOOL:
       {
     CfgBool* l_p = dynamic_cast<CfgBool*>(CfgVals[ i ]);
     if ( l_p->value() ) {
       fprintf( l_dumpfile, "true" );
     } else {
       fprintf( l_dumpfile, "false" );
     }
     break;
       }
     case CFG_STRING:
       {
     CfgStr* l_p = dynamic_cast<CfgStr*>(CfgVals[ i ]);
     fprintf( l_dumpfile, "\"%s\"", l_p->value() );
     break;
       }
     default:
       {
     char l_errno[20];
     sprintf( l_errno, "%d", CfgVals[ i ]->gettype() );
     g_msg->Warn( WARN_FILE, "Configurator::DumpSymbols() "
              "Unknown symbol type read:",
              l_errno );
     exit(1);
       }
     }
     fprintf( l_dumpfile, "  # %s\n",
          CfgSecureStrings[ CfgVals[ i ]->getlevel() ]
          );
   }
 
 }

char * Configurator::ExtractString ( char * a_line )

private

Definition at line 188 of file configurator.cpp.

References g_msg, LastDoubleQuote(), m_lineno, MapErrorMsg::Warn(), and WARN_FILE.

Referenced by ParseCfgLine().

 {
   char lineno[ 20 ];
 
   // scan for the first double quote or end of line.
   while ( *a_line != '"' && *a_line != '\0' ) {
     a_line++;
   }
 
   // The first char in the string had better contain a '"':
   if ( *a_line != '"' ) {
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::ExtractString()\n"
          "  String not enclosed in double quotes at "
          "config line ", lineno );
     exit(1);
   }
 
   char* endline = ++a_line;
   bool escaped = false, found = false;
 
   while ( *endline != '\0' ) {
     if ( *endline == '\\' ) {
       escaped = true;
       endline++;
 
       if ( *endline == '"' &&
        LastDoubleQuote( endline )) {
     escaped = false;
       } else {
     continue;
       }
     }
     if ( *endline == '"' && !escaped ) {
       // Found end of string, terminate properly and break the loop.
       *endline++ = '\0';
       found = true;
       break;
     }
     escaped = false;
     endline++;
   }
 
   if ( !found ) {
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::ExtractString() "
          "No ending double quote after string at "
          "config line ", lineno );
     exit(1);
   }
 
 
   // Check for comment if remainder of line isn't empty.
   if ( sscanf( endline, "%*s" ) == 1 ) {
     // Non-empty comment line.
     if ( sscanf( endline, "%*[#]" ) != 1 ) {
       // But not initiated by '#'.
       sprintf( lineno, "%d", m_lineno );
       g_msg->Warn( WARN_FILE, "Configurator::ExtractString() "
            "Illegal comment at "
            "config line ", lineno );
       exit(1);
     }
   }
 
   return a_line;
 }

bool Configurator::LastDoubleQuote ( char * a_rest_of_line )

private

Definition at line 257 of file configurator.cpp.

Referenced by ExtractString().

 {
   a_rest_of_line++;
 
   while ( *a_rest_of_line != '\0' && *a_rest_of_line != '#' ) {
     if ( *a_rest_of_line == '"' ) {
       return false;
     }
     a_rest_of_line++;
   }
   return true;
 }

void Configurator::ParseCfgLine ( char * a_line )

private

Definition at line 272 of file configurator.cpp.

References CFG_MAX_LINE_LENGTH, CfgI, ExtractString(), g_msg, m_lineno, SetCfgBool(), SetCfgFloat(), SetCfgInt(), SetCfgStr(), MapErrorMsg::Warn(), and WARN_FILE.

Referenced by ReadSymbols().

 {
   char l_id  [ CFG_MAX_LINE_LENGTH ];
   char l_type[ CFG_MAX_LINE_LENGTH ];
   char l_sep [ CFG_MAX_LINE_LENGTH ];
   char l_val [ CFG_MAX_LINE_LENGTH ];
   char l_comm[ CFG_MAX_LINE_LENGTH ];
   char lineno[20];
 
   if ( sscanf( a_line, "%[#]", l_id ) == 1 ) {
     // Comment line.
     return;
   }
 
   if ( sscanf( a_line, "%s", l_id) == EOF ) {
     // Empty line consisting only of white spaces.
     return;
   }
 
   //int l_conv = sscanf( a_line, "%[A-Z_] (%[a-z]) %s", l_id, sizeof(l_id),l_type,sizeof(l_type), l_sep,sizeof(l_sep) );
 int l_conv = sscanf( a_line, "%[A-Z_] (%[a-z]) %s", l_id, l_type, l_sep );
 
   if ( l_conv < 3 ) {
     // Syntax terror.
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::ParseCfgLine() "
          "Syntax error at config line ",
          lineno );
     exit(1);
   }
 
   if ( strcmp( l_sep, "=" ) != 0 ) {
     // Missing '=' assignment separator.
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::ParseCfgLine() "
          "Missing '=' assignment operator at config line ",
          lineno );
     exit(1);
   }
 
   if ( CfgI.find( l_id ) == CfgI.end() ) {
     // Key doesn't exists among the predefined, global configuration
     // variables. Ignore quietly.
     return;
   }
 
   if ( strlen( l_type ) == 6 &&
        strncmp( l_type, "string", 6 ) == 0 ) {
     // We are not yet ready to do the assignment.
     // If we really have a string enclosed in non-escaped
     // double quotes at the end of the line, then we need to
     // extract it first from our input.
     SetCfgStr( l_id, ExtractString( a_line ));
     return;
   }
 
   // Not a string, so extract data value and possible comment.
   l_conv = sscanf( a_line, "%*[A-Z_] (%*[a-z]) %*s %s %s",
            l_val, l_comm );
 
   if ( l_conv == 2 && l_comm[0] != '#' ) {
     // Illegal comment at end of line.
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::ParseCfgLine() "
          "Syntax error at end of config line ",
          lineno );
     exit(1);
   }
 
   if ( strlen( l_type ) == 5 &&
        strncmp( l_type, "float", 5 ) == 0 ) {
     SetCfgFloat( l_id, l_val );
     return;
   }
 
   if ( strlen( l_type ) == 4 &&
        strncmp( l_type, "bool", 4 ) == 0 ) {
     SetCfgBool( l_id, l_val );
     return;
   }
 
   if ( strlen( l_type ) == 3 &&
        strncmp( l_type, "int", 3 ) == 0 ) {
     SetCfgInt( l_id, l_val );
     return;
   }
 
   sprintf( lineno, "%d", m_lineno );
   g_msg->Warn( WARN_FILE, "Configurator::ParseCfgLine() "
            "Unknown type specifier at config line ",
            lineno );
   exit(1);
 }

bool Configurator::ReadSymbols ( const char * a_cfgfile )

Definition at line 166 of file configurator.cpp.

References CFG_MAX_LINE_LENGTH, g_msg, m_lineno, ParseCfgLine(), MapErrorMsg::Warn(), and WARN_FILE.

Referenced by Landscape::Landscape(), and Landscape::ReadSymbols().

                                                       {
     ifstream cf_file;
     char cfgline[ CFG_MAX_LINE_LENGTH ];
     cf_file.open(a_cfgfile,fstream::in);
     if ( !cf_file.is_open() ) {
         g_msg->Warn( WARN_FILE, "Configurator::ReadSymbols() Unable to open file for reading: ", a_cfgfile );
         exit(1);
     }
     while ( !cf_file.eof()) {
         for (unsigned i=0; i< CFG_MAX_LINE_LENGTH; i++) cfgline[i]=' '; // Done to get rid of the rubbish that otherwise messes up the parse
         cf_file.getline(cfgline,CFG_MAX_LINE_LENGTH);
         ParseCfgLine( cfgline );
         m_lineno++;
     }
     cf_file.close();
     return true;
 }

bool Configurator::Register	(	CfgBase *	a_cfgval,
		const char *	a_key
	)

Definition at line 147 of file configurator.cpp.

References CfgI, and CfgVals.

Referenced by CfgBase::CfgBase().

 {
   string l_key = a_key;
 
   if ( CfgI.find( l_key ) != CfgI.end() ) {
     // Couldn't register, already exists.
     return false;
   }
 
   unsigned int i   = (int) CfgVals.size();
   CfgI[ l_key ]    = i;
   CfgVals.resize( i+1 );
   CfgVals[ i ]     = a_cfgval;
 
   return true;
 }

void Configurator::SetCfgBool	(	char *	a_key,
		char *	a_val
	)

private

Definition at line 444 of file configurator.cpp.

References CFG_BOOL, CfgI, CfgVals, g_msg, CfgBase::getlevel(), CfgStr::gettype(), m_lineno, SetCfgGatekeeper(), ShowIdType(), MapErrorMsg::Warn(), and WARN_FILE.

Referenced by ParseCfgLine().

 {
   char lineno[20];
   string l_key = a_key;
   bool   l_val = false;
 
   if ( strcmp ( a_val, "false" ) == 0 ) {
     ; // l_val defaults to false.
   } else if ( strcmp ( a_val, "true" ) == 0 ) {
     l_val = true;
   } else {
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::SetCfgBool() "
          "Not a boolean data value at config line",
          lineno );
     exit(1);
   }
 
   // Check access security.
   unsigned int i         = CfgI[ l_key ];
   if ( SetCfgGatekeeper( "Configurator::SetCfgBool() "
              "Attempting to set public config variable in line",
              a_key,
              CfgVals[ i ]->getlevel()
              )) {
     return;
   }
 
   if ( CfgVals[ i ]->gettype() != CFG_BOOL ) {
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::SetCfgBool() "
          "Non-boolean identifier specified at config line",
          lineno );
     ShowIdType( i );
     exit(1);
   }
 
   dynamic_cast<CfgBool*>(CfgVals[ i ])->set( l_val );
 }

void Configurator::SetCfgFloat	(	char *	a_key,
		char *	a_val
	)

private

Definition at line 486 of file configurator.cpp.

References CFG_FLOAT, CfgI, CfgVals, FloatToDouble(), g_msg, CfgBase::getlevel(), CfgStr::gettype(), m_lineno, SetCfgGatekeeper(), ShowIdType(), MapErrorMsg::Warn(), and WARN_FILE.

Referenced by ParseCfgLine().

 {
   double l_val;
   float f;
   char lineno[20];
   string l_key = a_key;
 
   if ( sscanf( a_val, "%f", &f) != 1 ) {
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::SetCfgFloat() "
          "Not a floating point data value at config line",
          lineno );
     exit(1);
   }
   FloatToDouble(l_val,f);
 
   // Check access security.
   unsigned int i         = CfgI[ l_key ];
   if ( SetCfgGatekeeper( "Configurator::SetCfgFloat() "
              "Attempting to set public config variable in line",
              a_key,
              CfgVals[ i ]->getlevel()
              )) {
     return;
   }
 
   if ( CfgVals[ i ]->gettype() != CFG_FLOAT ) {
 sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::SetCfgFloat() "
          "Non-floating point identifier specified at config line",
          lineno );
     ShowIdType( i );
     exit(1);
   }
 
   dynamic_cast<CfgFloat*>(CfgVals[ i ])->set( l_val );
 }

bool Configurator::SetCfgGatekeeper	(	const char *	a_method,
		const char *	a_key,
		CfgSecureLevel	a_level
	)

private

Definition at line 380 of file configurator.cpp.

References CFG_PRIVATE, CFG_PUBLIC, g_msg, l_cfg_public_exit_on_set, l_cfg_public_warn_on_set, m_lineno, CfgBool::value(), MapErrorMsg::Warn(), and WARN_FILE.

Referenced by SetCfgBool(), SetCfgFloat(), SetCfgInt(), and SetCfgStr().

 {
   if ( a_level == CFG_PRIVATE ) {
     // Attempting to set private config variable. Ignore quietly.
     return true;
   }
 
   if ( a_level == CFG_PUBLIC &&
        l_cfg_public_warn_on_set.value()) {
     // Attempting to set public config variable. Warn and
     // possibly exit if this is configured.
     char lineno[20];
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, a_method, lineno );
 
     if ( l_cfg_public_exit_on_set.value()) {
       exit(1);
     }
     return true;
   }
   return false;
 }

void Configurator::SetCfgInt	(	char *	a_key,
		char *	a_val
	)

private

Definition at line 407 of file configurator.cpp.

References CFG_INT, CfgI, CfgVals, g_msg, CfgBase::getlevel(), CfgStr::gettype(), m_lineno, SetCfgGatekeeper(), ShowIdType(), MapErrorMsg::Warn(), and WARN_FILE.

Referenced by ParseCfgLine().

 {
   int l_val;
   char lineno[20];
   string l_key = a_key;
 
   if ( sscanf( a_val, "%d", &l_val ) != 1 ) {
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::SetCfgInt() "
          "Not an integer data value at config line",
          lineno );
     exit(1);
   }
 
   // Check access security.
   unsigned int i         = CfgI[ l_key ];
   if ( SetCfgGatekeeper( "Configurator::SetCfgInt() "
              "Attempting to set public config variable in line",
              a_key,
              CfgVals[ i ]->getlevel()
              )) {
     return;
   }
 
   if ( CfgVals[ i ]->gettype() != CFG_INT ) {
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::SetCfgInt() "
          "Non-integer identifier specified at config line",
          lineno );
     ShowIdType( i );
     exit(1);
   }
 
   dynamic_cast<CfgInt*>(CfgVals[ i ])->set( l_val );
 }

void Configurator::SetCfgStr	(	char *	a_key,
		char *	a_val
	)

private

Definition at line 526 of file configurator.cpp.

References CFG_STRING, CfgI, CfgVals, g_msg, CfgBase::getlevel(), CfgStr::gettype(), m_lineno, SetCfgGatekeeper(), ShowIdType(), MapErrorMsg::Warn(), and WARN_FILE.

Referenced by ParseCfgLine().

 {
   char lineno[20];
   string l_key = a_key;
 
   // Check access security.
   unsigned int i         = CfgI[ l_key ];
   if ( SetCfgGatekeeper( "Configurator::SetCfgStr() "
              "Attempting to set public config variable in line",
              a_key,
              CfgVals[ i ]->getlevel()
              )) {
     return;
   }
 
   if ( CfgVals[ i ]->gettype() != CFG_STRING ) {
     sprintf( lineno, "%d", m_lineno );
     g_msg->Warn( WARN_FILE, "Configurator::SetCfgStr() "
          "Non-string identifier specified at config line",
          lineno );
     ShowIdType( i );
     exit(1);
   }
 
   dynamic_cast<CfgStr*>(CfgVals[ i ])->set( a_val );
 }

void Configurator::ShowIdType ( unsigned int a_i )

private

Definition at line 368 of file configurator.cpp.

References CfgTypeStrings, CfgVals, g_msg, CfgBase::getkey(), CfgStr::gettype(), WARN_FILE, and MapErrorMsg::WarnAddInfo().

Referenced by SetCfgBool(), SetCfgFloat(), SetCfgInt(), and SetCfgStr().

 {
   g_msg->WarnAddInfo( WARN_FILE,
               "Type for identifier ",
               CfgVals[ a_i ]->getkey().c_str() );
   g_msg->WarnAddInfo( WARN_FILE, " is (",
               CfgTypeStrings[ CfgVals[ a_i ]->gettype() ] );
   g_msg->WarnAddInfo( WARN_FILE, ")\n", "" );
 }