Configuration Class Reference
Configuration file handling.
More...
#include <yatengine.h>
List of all members.
|
Public Member Functions |
| Configuration () |
| Configuration (const char *filename, bool warn=true) |
Configuration & | operator= (const String &value) |
unsigned int | sections () const |
NamedList * | getSection (unsigned int index) const |
NamedList * | getSection (const String §) const |
NamedString * | getKey (const String §, const String &key) const |
const char * | getValue (const String §, const String &key, const char *defvalue=0) const |
int | getIntValue (const String §, const String &key, int defvalue=0) const |
int | getIntValue (const String §, const String &key, const TokenDict *tokens, int defvalue=0) const |
double | getDoubleValue (const String §, const String &key, double defvalue=0.0) const |
bool | getBoolValue (const String §, const String &key, bool defvalue=false) const |
void | clearSection (const char *sect=0) |
NamedList * | createSection (const String §) |
void | clearKey (const String §, const String &key) |
void | addValue (const String §, const char *key, const char *value=0) |
void | setValue (const String §, const char *key, const char *value=0) |
void | setValue (const String §, const char *key, int value) |
void | setValue (const String §, const char *key, bool value) |
bool | load (bool warn=true) |
bool | save () const |
Detailed Description
Configuration file handling.
A class for parsing and quickly accessing INI style configuration files
Constructor & Destructor Documentation
Create an empty configuration
Configuration |
( |
const char * |
filename, |
|
|
bool |
warn = true | |
|
) |
| | [explicit] |
Create a configuration from a file
- Parameters:
-
| filename | Name of file to initialize from |
| warn | True to warn if the configuration could not be loaded |
Member Function Documentation
unsigned int sections |
( |
|
) |
const [inline] |
Get the number of sections
- Returns:
- Count of sections
NamedList* getSection |
( |
unsigned int |
index |
) |
const |
Retrieve an entire section
- Parameters:
-
| index | Index of the section |
- Returns:
- The section's content or NULL if no such section
Retrieve an entire section
- Parameters:
-
- Returns:
- The section's content or NULL if no such section
Locate a key/value pair in the section.
- Parameters:
-
| sect | Name of the section |
| key | Name of the key in section |
- Returns:
- A pointer to the key/value pair or NULL.
const char* getValue |
( |
const String & |
sect, |
|
|
const String & |
key, |
|
|
const char * |
defvalue = 0 | |
|
) |
| | const |
Retrieve the value of a key in a section.
- Parameters:
-
| sect | Name of the section |
| key | Name of the key in section |
| defvalue | Default value to return if not found |
- Returns:
- The string contained in the key or the default
int getIntValue |
( |
const String & |
sect, |
|
|
const String & |
key, |
|
|
int |
defvalue = 0 | |
|
) |
| | const |
Retrieve the numeric value of a key in a section.
- Parameters:
-
| sect | Name of the section |
| key | Name of the key in section |
| defvalue | Default value to return if not found |
- Returns:
- The number contained in the key or the default
int getIntValue |
( |
const String & |
sect, |
|
|
const String & |
key, |
|
|
const TokenDict * |
tokens, |
|
|
int |
defvalue = 0 | |
|
) |
| | const |
Retrieve the numeric value of a key in a section trying first a table lookup.
- Parameters:
-
| sect | Name of the section |
| key | Name of the key in section |
| tokens | A pointer to an array of tokens to try to lookup |
| defvalue | Default value to return if not found |
- Returns:
- The number contained in the key or the default
double getDoubleValue |
( |
const String & |
sect, |
|
|
const String & |
key, |
|
|
double |
defvalue = 0.0 | |
|
) |
| | const |
Retrieve the floating point value of a key in a section.
- Parameters:
-
| sect | Name of the section |
| key | Name of the key in section |
| defvalue | Default value to return if not found |
- Returns:
- The numeric value contained in the key or the default
bool getBoolValue |
( |
const String & |
sect, |
|
|
const String & |
key, |
|
|
bool |
defvalue = false | |
|
) |
| | const |
Retrieve the boolean value of a key in a section.
- Parameters:
-
| sect | Name of the section |
| key | Name of the key in section |
| defvalue | Default value to return if not found |
- Returns:
- The boolean value contained in the key or the default
void clearSection |
( |
const char * |
sect = 0 |
) |
|
Deletes an entire section
- Parameters:
-
| sect | Name of section to delete, NULL to delete all |
Makes sure a section with a given name exists, creates if required
- Parameters:
-
| sect | Name of section to check or create |
- Returns:
- The section's content or NULL if no such section
Deletes a key/value pair
- Parameters:
-
| sect | Name of section |
| key | Name of the key to delete |
void addValue |
( |
const String & |
sect, |
|
|
const char * |
key, |
|
|
const char * |
value = 0 | |
|
) |
| | |
Add the value of a key in a section.
- Parameters:
-
| sect | Name of the section, will be created if missing |
| key | Name of the key to add in the section |
| value | Value to set in the key |
void setValue |
( |
const String & |
sect, |
|
|
const char * |
key, |
|
|
const char * |
value = 0 | |
|
) |
| | |
Set the value of a key in a section.
- Parameters:
-
| sect | Name of the section, will be created if missing |
| key | Name of the key in section, will be created if missing |
| value | Value to set in the key |
void setValue |
( |
const String & |
sect, |
|
|
const char * |
key, |
|
|
int |
value | |
|
) |
| | |
Set the numeric value of a key in a section.
- Parameters:
-
| sect | Name of the section, will be created if missing |
| key | Name of the key in section, will be created if missing |
| value | Value to set in the key |
void setValue |
( |
const String & |
sect, |
|
|
const char * |
key, |
|
|
bool |
value | |
|
) |
| | |
Set the boolean value of a key in a section.
- Parameters:
-
| sect | Name of the section, will be created if missing |
| key | Name of the key in section, will be created if missing |
| value | Value to set in the key |
bool load |
( |
bool |
warn = true |
) |
|
Load the configuration from file
- Parameters:
-
| warn | True to also warn if the configuration could not be loaded |
- Returns:
- True if successfull, false for failure
Save the configuration to file
- Returns:
- True if successfull, false for failure
The documentation for this class was generated from the following file: