UCommon
|
Data keys parsed from a keyfile. More...
#include <keydata.h>
Data Structures | |
class | keyvalue |
A key value set is used for iterative access. More... | |
Public Types | |
typedef linked_pointer< keyvalue > | pointer |
Convenience typedef for iterative pointer. | |
Public Member Functions | |
keyvalue * | begin (void) const |
Get first value object, for iterative examinations. More... | |
void | clear (const char *id) |
Remove a keyword id from the keydata structure. More... | |
keyvalue * | end (void) const |
Get last value object, for iterative examinations. More... | |
const char * | get (const char *id) const |
Lookup a key value by it's id. More... | |
const char * | get (void) const |
Get the name of this section. More... | |
const char * | operator() (const char *id) const |
Lookup a key value by it's id. More... | |
void | set (const char *id, const char *value) |
Set a keyword and value in the keydata structure. More... | |
![]() | |
void | delist (OrderedIndex *index) |
Remove our ordered object from an existing index. More... | |
virtual void | enlist (OrderedIndex *index) |
List our ordered object in default strategy mode. More... | |
void | enlistHead (OrderedIndex *index) |
List our ordered object at start of a linked list on an index. More... | |
void | enlistTail (OrderedIndex *index) |
List our ordered object at end of a linked list on an index. More... | |
OrderedObject * | getNext (void) const |
Get next ordered member when iterating. More... | |
![]() | |
void | delist (LinkedObject **root) |
Locate and remove ourselves from a list of objects. More... | |
void | enlist (LinkedObject **root) |
Add our object to an existing linked list through a pointer. More... | |
LinkedObject * | getNext (void) const |
Get next effective object when iterating. More... | |
bool | is_member (LinkedObject *list) const |
Search to see if we are a member of a specific list. More... | |
virtual void | release (void) |
Release list, mark as no longer linked. More... | |
virtual void | retain (void) |
Retain by marking as self referenced list. More... | |
![]() | |
ObjectProtocol * | copy (void) |
Retain (increase retention of) object when copying. | |
void | operator++ (void) |
Increase retention operator. | |
void | operator-- (void) |
Decrease retention operator. | |
virtual | ~ObjectProtocol () |
Required virtual destructor. | |
Friends | |
class | keyfile |
class | keyvalue |
Additional Inherited Members | |
![]() | |
static unsigned | count (const LinkedObject *root) |
Count the number of linked objects in a list. More... | |
static LinkedObject * | getIndexed (LinkedObject *root, unsigned index) |
Get member by index. More... | |
static void | purge (LinkedObject *root) |
Release all objects from a list. More... | |
![]() | |
OrderedObject (OrderedIndex *index) | |
Construct an ordered object aot end of a an index. More... | |
OrderedObject () | |
Construct an ordered object unattached. | |
OrderedObject (const OrderedObject &from) | |
![]() | |
LinkedObject (LinkedObject **root) | |
Construct base class attached to a chain of objects. More... | |
LinkedObject () | |
Construct base class unattached to anyone. More... | |
LinkedObject (const LinkedObject &from) | |
![]() | |
LinkedObject * | Next |
Data keys parsed from a keyfile.
This is a specific [] section from a fully loaded keyfile, and offers common means to access data members. This is related to the original GNU Common C++ keydata object, although it is formed in a keyfile class which is loaded from a config file all at once.
|
inline |
void ucommon::keydata::clear | ( | const char * | id | ) |
Remove a keyword id from the keydata structure.
Removed items still use pager allocated memory.
id | to remove. |
|
inline |
const char* ucommon::keydata::get | ( | const char * | id | ) | const |
Lookup a key value by it's id.
id | to look for. |
|
inline |
|
inline |
void ucommon::keydata::set | ( | const char * | id, |
const char * | value | ||
) |
Set a keyword and value in the keydata structure.
If the keyword already exists, it is replaced. Removed items still use pager allocated memory.
id | to set. |
value | for the id. |