ConfigFile Class Reference

#include <configfile.h>

Collaboration diagram for ConfigFile:

[legend]

List of all members.

Classes
struct	TokenValue
Public Member Functions
	ConfigFile ()
	~ConfigFile ()
void	readFile (string fileName)
std::string	getCurrentFile ()
string	getString (string key)
double	getDouble (string key)
double	getDouble (string key, double def)
int	getInt (string key)
int	getInt (string key, int def)
unsigned	getUnsigned (string key)
bool	isDefined (string key)
Private Types
enum	TokenId {   STRING, KEY, ASSIGN_OPERATOR, COMMENT,   INVALID_TOKEN, NUMBER, END_OF_FILE }
typedef __gnu_cxx::hash_map < string, struct TokenValue, StringHashFun, struct eqstr >	KeysMap
Private Member Functions
TokenId	getToken (std::ifstream &file)
Private Attributes
char	strToken [TOKEN_SIZE]
int	numLines
KeysMap	keysMap
std::string	m_currFile

---

Detailed Description

Definition at line 15 of file configfile.h.

---

Member Typedef Documentation

typedef __gnu_cxx::hash_map<string,struct TokenValue,StringHashFun,struct eqstr> ConfigFile::KeysMap [private]

Definition at line 36 of file configfile.h.

---

Member Enumeration Documentation

enum ConfigFile::TokenId [private]

Enumerator:

STRING
KEY
ASSIGN_OPERATOR
COMMENT
INVALID_TOKEN
NUMBER
END_OF_FILE

Definition at line 21 of file configfile.h.

{STRING,KEY,ASSIGN_OPERATOR,COMMENT,INVALID_TOKEN,NUMBER,END_OF_FILE};

---

Constructor & Destructor Documentation

ConfigFile::ConfigFile

(

)

Definition at line 5 of file configfile.cpp.

{
  numLines = 1;
}

ConfigFile::~ConfigFile

(

)

Definition at line 11 of file configfile.cpp.

{

}

---

Member Function Documentation

std::string ConfigFile::getCurrentFile

(

)

[inline]

Definition at line 49 of file configfile.h.

{return m_currFile;}

double ConfigFile::getDouble	(	string	key,
		double	def
	)

Definition at line 205 of file configfile.cpp.

{
  if (keysMap.find(key) != keysMap.end())
  {
    TokenValue &tk = keysMap[key];
    if (tk.tokenId != NUMBER)
    {
      throw new Exception("ConfigFile Error: Key %s is not a NUMBER\n",key.c_str());
      
    }
    return atof(tk.value.c_str());
  }
  else
  {
    return def;
    
  }
  return NAN;

}

double ConfigFile::getDouble

(

std::string

key

)

Return the string assigned to the key passed as parameter. If the key does not exist or the the assigned to the key is not a number, the method throws an exception

Parameters:

key

Name of the field whose value is to be extracted

Definition at line 184 of file configfile.cpp.

{
  if (keysMap.find(key) != keysMap.end())
  {
    TokenValue &tk = keysMap[key];
    if (tk.tokenId != NUMBER)
    {
      throw new Exception("ConfigFile Error: Key %s is not a NUMBER\n",key.c_str());
      
    }
    return atof(tk.value.c_str());
  }
  else
  {
    throw new Exception("ConfigFile Error: Key %s not found\n",key.c_str());
    
  }
  return NAN;
}

int ConfigFile::getInt	(	string	key,
		int	def
	)

Get the value from the config file.

Parameters:

	key	Value to get
	def	Value to return if the key is not defined

Returns:

The int value of the key;

Definition at line 246 of file configfile.cpp.

{
  if (isDefined(key))
    return (int) getDouble(key);
  else return def;
}

int ConfigFile::getInt

(

string

key

)

Get the value from the config file.

Parameters:

key

Value to get

Returns:

The int value of the key;

Definition at line 235 of file configfile.cpp.

{
  return (int) getDouble(key);
}

std::string ConfigFile::getString

(

std::string

key

)

Return the string assigned to the key passed as parameter. If the key does not exist or the the assigned to the key is not a string, the method throws an exception

Parameters:

key

Name of the field whose value is to be extracted

Definition at line 160 of file configfile.cpp.

{
  if (keysMap.find(key) != keysMap.end())
  {
    TokenValue &tk = keysMap[key];
    if (tk.tokenId != STRING)
    {
      throw new Exception("ConfigFile Error: Key value %s is not a string\n",key.c_str());
      
    }
    return tk.value;
  }
  else
  {
    throw new Exception("ConfigFile Error: Key value %s not found\n",key.c_str());
        
  }
  return "";
}

ConfigFile::TokenId ConfigFile::getToken

(

std::ifstream &

file

)

[private]

Get a token.

This is an internal function who identify the tokens copying the text matched to the attribute strToken.

Parameters:

file

Returns:

Definition at line 75 of file configfile.cpp.

{
  int c;
 begin:
  c = file.get();
  if (isblank(c))
    goto begin;
  else if (c == '\n')
  {
    numLines++;
    goto begin;
  }
  else if (c == '#')
  {
    file.unget();
    file.getline(strToken,TOKEN_SIZE);
    numLines++;
    return COMMENT;
  }
  else if (c == '=')
    return ASSIGN_OPERATOR;
  else if (isalpha(c))
  {
    char *p = strToken;
    while ( (isalnum(c) || c == '_' ) && (p-strToken) < TOKEN_SIZE )
    {
      *p++ = c;
      c=file.get();
    }
    if (p - strToken == TOKEN_SIZE)
    {
      throw new Exception("ConfigFile Error: Token too large at line %d\n",numLines);
      
    }
    *p='\0';
    file.unget();
    return KEY;
  }
  else if (c == '"')
  {
    char *p = strToken;
    c=file.get();
    while (c != '"' && ((p-strToken) < TOKEN_SIZE) && !file.eof())
    {
      *p++ = c;
      c=file.get();
    }
    if ( (p - strToken) == TOKEN_SIZE)
    {
      throw new Exception("ConfigFile Error: Token too large at line %d\n",numLines);
      
    }
    if (file.eof())
    {
      throw new Exception("ConfigFile Error: Unexpected End of File, the string value is not closed in the right way\n");
      
    }
    *p='\0';
    return STRING;
  }
  else if (isdigit(c) || c == '+' || c == '-')
  {
    double d;
    file.unget();
    file >> d;
    if (file.fail())
    {
      throw new Exception("ConfigFile Error: Invalid Number at line %d\n",numLines);
      
    }
    sprintf(strToken,"%g",d);
    return NUMBER;
  }
  else if (c == EOF)
    return END_OF_FILE;
  else
    return INVALID_TOKEN;
}

unsigned ConfigFile::getUnsigned

(

string

key

)

Definition at line 255 of file configfile.cpp.

{
  double dd = getDouble(key);
  if (dd < 0)
    throw new Exception("ConfigFile Error: Expect an unsigned integer for the Key %s\n",key.c_str());
  return (unsigned) dd;
}

bool ConfigFile::isDefined

(

string

key

)

Returns if the key is defined in config file.

Parameters:

key

Returns:

Definition at line 268 of file configfile.cpp.

{
  return (keysMap.find(key) != keysMap.end());
}

void ConfigFile::readFile

(

string

fileName

)

Read the file storing the values of the variables configurated in the file in a intern table.

Parameters:

fileName

Name of the file;

Definition at line 21 of file configfile.cpp.

{
  m_currFile=fileName;
  std::string str;
  std::ifstream file(fileName.c_str());
  if (file.eof())
    return;
  if (file.fail())
  {
    throw new Exception("Config file \"%s\" not found\nQuitting",fileName.c_str());
  }
  while (!file.eof())
  {
    TokenId token = getToken(file);
    if (token == COMMENT)
      continue;
    if (token == KEY)
    {
      //If token is KEY, then strToken has the name of the key;
      std::string strKey = this->strToken;

      if (getToken(file) != ASSIGN_OPERATOR)
      {
        throw new Exception("ConfigFile Error: Expect the assignment operator \"=\" at line %d",numLines);
        
      }

      TokenValue tk;
      tk.tokenId = getToken(file);
      if (tk.tokenId != STRING && tk.tokenId != NUMBER)
      {
        throw new Exception("ConfigFile Error: Expect a STRING or NUMBER at line %d",numLines);
        
      }
      tk.value = strToken;
      keysMap[strKey]=tk;
    }
    else if (token == END_OF_FILE)
      return;
    else if (token == INVALID_TOKEN)
    {
      throw new Exception("ConfigFile Error: Invalid token found at line %d",numLines);
      
    }

  }
  file.close();
}

---

Member Data Documentation

KeysMap ConfigFile::keysMap [private]

Definition at line 38 of file configfile.h.

std::string ConfigFile::m_currFile [private]

Definition at line 40 of file configfile.h.

int ConfigFile::numLines [private]

Contem numero de linhas lidas até agora

Definition at line 19 of file configfile.h.

char ConfigFile::strToken[TOKEN_SIZE] [private]

String to store the tokens readed with the method getToken()

Definition at line 18 of file configfile.h.

---

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

• configfile.h
• configfile.cpp