UCommon
|
Traditional keypair config file parsing class. More...
#include <keydata.h>
Public Types | |
typedef linked_pointer< keydata > | iterator |
Convenience typedef for iterative pointer. | |
Public Member Functions | |
keydata * | begin (void) const |
Get first keydata object, for iterative examinations. | |
keydata * | end (void) const |
Get last keydata object, for iterative examinations. | |
int | err (void) |
keydata * | get (const char *section) const |
Get a keydata section name. | |
keydata * | get (void) const |
Get the non-sectioned defaults if there are any. | |
keyfile (size_t pagesize=0) | |
Create an empty key file ready for loading. | |
keyfile (const char *path, size_t pagesize=0) | |
Create a key file object from an existing config file. | |
keyfile (const keyfile ©, size_t pagesize=0) | |
void | load (const char *path) |
Load (overlay) another config file over the currently loaded one. | |
void | load (const keyfile *source) |
Load from an existing keyfile object. | |
void | load (const keydata *source) |
Load a single set of keys. | |
keydata * | operator() (const char *section) const |
keydata * | operator[] (const char *section) const |
void | release (void) |
Release and re-initialize keyfile. | |
bool | save (const char *path) |
Save (write) a set of config keys to dist. | |
Protected Member Functions | |
keydata * | create (const char *section) |
Friends | |
class | keydata |
Traditional keypair config file parsing class.
This is used to get generic config data either from a /etc/xxx.conf, a windows style xxx.ini file, or a ~/.xxxrc file, and parses [] sections from the entire file at once.
ucommon::keyfile::keyfile | ( | size_t | pagesize = 0 | ) |
Create an empty key file ready for loading.
pagesize | for memory paging. |
ucommon::keyfile::keyfile | ( | const char * | path, |
size_t | pagesize = 0 |
||
) |
Create a key file object from an existing config file.
path | to load from. |
pagesize | for memory paging. |
keydata* ucommon::keyfile::begin | ( | void | ) | const [inline] |
keydata* ucommon::keyfile::end | ( | void | ) | const [inline] |
keydata* ucommon::keyfile::get | ( | const char * | section | ) | const |
Get a keydata section name.
section | name to look for. |
keydata* ucommon::keyfile::get | ( | void | ) | const [inline] |
void ucommon::keyfile::load | ( | const char * | path | ) |
Load (overlay) another config file over the currently loaded one.
This is used to merge key data, such as getting default values from a global config, and then overlaying a local home config file.
path | to load keys from into current object. |
void ucommon::keyfile::load | ( | const keyfile * | source | ) |
Load from an existing keyfile object.
source | to copy from. |
void ucommon::keyfile::load | ( | const keydata * | source | ) |
Load a single set of keys.
source | of keys to copy. |
bool ucommon::keyfile::save | ( | const char * | path | ) |
Save (write) a set of config keys to dist.
path | of file to save keys to. |