#include <uniconfgen.h>
Inherits GenericComponent< IObject >.
Inherited by UniClientGen, UniFilterGen, UniListGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniRegistryGen, UniTempGen, and UniWvConfGen.
Collaboration diagram for UniConfGen:
This is intended to be implemented to provide support for fetching and storing keys and values using different access methods.
Definition at line 42 of file uniconfgen.h.
Public Member Functions | |
virtual | ~UniConfGen () |
Destroys the UniConfGen and may discard uncommitted data. | |
void | setcallback (const UniConfGenCallback &callback, void *userdata) |
Sets the callback for change notification. | |
void | dispatch_delta (const UniConfKey &key, WvStringParm value) |
Immediately sends notification that a key has possibly changed. | |
void | hold_delta () |
Pauses notifications until matched with a call to unhold_delta(). | |
void | unhold_delta () |
Resumes notifications when each hold_delta() has been matched. | |
void | clear_delta () |
Clears the list of pending notifications without sending them. | |
void | flush_delta () |
Flushes the list of pending notifications by sending them. | |
void | delta (const UniConfKey &key, WvStringParm value) |
Call this when a key's value or children have possibly changed. | |
virtual bool | isok () |
Determines if the generator is usable and working properly. | |
virtual void | commit () |
Commits any changes. | |
virtual bool | refresh () |
Refreshes information about a key recursively. | |
virtual WvString | get (const UniConfKey &key)=0 |
Fetches a string value for a key from the registry. | |
virtual bool | exists (const UniConfKey &key) |
Without fetching its value, returns true if a key exists. | |
virtual int | str2int (WvStringParm s, int defvalue) const |
Converts a string to an integer. | |
virtual void | set (const UniConfKey &key, WvStringParm value)=0 |
Stores a string value for a key into the registry. | |
virtual bool | haschildren (const UniConfKey &key) |
Returns true if a key has children. | |
virtual Iter * | iterator (const UniConfKey &key)=0 |
Returns an iterator over the children of the specified key. | |
virtual unsigned int | addRef () |
virtual unsigned int | release () |
Protected Member Functions | |
UniConfGen () | |
Creates a UniConfGen object. | |
void | seterror (WvStringParm error) |
Raises an error condition. |
|
Creates a UniConfGen object.
Definition at line 12 of file uniconfgen.cc. |
|
Destroys the UniConfGen and may discard uncommitted data.
Definition at line 18 of file uniconfgen.cc. |
|
Implements IObject. |
|
Clears the list of pending notifications without sending them. Does not affect the hold nesting count. Definition at line 38 of file uniconfgen.cc. |
|
Commits any changes. The default implementation does nothing. Reimplemented in UniFilterGen, UniIniGen, UniListGen, UniMountGen, and UniMountTreeGen. Definition at line 135 of file uniconfgen.h. Referenced by UniFilterGen::commit(), UniMountTreeGen::unmount(), and UniMountGen::unmount(). |
|
Call this when a key's value or children have possibly changed. If the hold nesting count is 0, the notification is sent immediately. Otherwise it is added to a pending list for later. Definition at line 69 of file uniconfgen.cc. References dispatch_delta(), hold_delta(), unhold_delta(), and WvStringParm. Referenced by UniClientGen::deltacb(), UniFilterGen::gencallback(), UniMountGen::mountgen(), UniIniGen::refresh(), UniTempGen::set(), UniRegistryGen::set(), UniPStoreGen::set(), and UniMountGen::unmount(). |
|
Immediately sends notification that a key has possibly changed. Takes care of the details of invoking the callback. Note: You probably want to be using delta() instead. Definition at line 62 of file uniconfgen.cc. References WvStringParm. Referenced by delta(), and flush_delta(). |
|
Without fetching its value, returns true if a key exists. This is provided because it is often more efficient to test existance than to actually retrieve the value. The default implementation returns !get(key).isnull(). Reimplemented in UniFilterGen, UniListGen, UniMountGen, UniMountTreeGen, UniPStoreGen, UniRegistryGen, UniSecureGen, and UniTempGen. Definition at line 99 of file uniconfgen.cc. References get(), and WvFastString::isnull(). Referenced by UniMountTreeGen::exists(), UniMountGen::exists(), UniFilterGen::exists(), and UniMountTreeGen::whichmount(). |
|
Flushes the list of pending notifications by sending them. Does not affect the hold nesting count. Definition at line 44 of file uniconfgen.cc. References dispatch_delta(). Referenced by unhold_delta(). |
|
Fetches a string value for a key from the registry. If the key doesn't exist, the return value is WvString::null. Implemented in UniClientGen, UniDefGen, UniFilterGen, UniListGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniRegistryGen, UniSecureGen, UniTempGen, and UniWvConfGen. Referenced by exists(), UniMountTreeGen::get(), UniMountGen::get(), UniFilterGen::get(), UniPermGen::getgroup(), UniPermGen::getowner(), and UniCacheGen::loadtree(). |
|
Returns true if a key has children. This is provided because it is often more efficient to test existance than to actually retrieve the keys. The default implementation uses the iterator returned by iterator() to test whether the child has any keys. Subclasses are strongly encouraged to provide a better implementation. Reimplemented in UniClientGen, UniFilterGen, UniListGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniRegistryGen, UniSecureGen, UniTempGen, and UniWvConfGen. Definition at line 85 of file uniconfgen.cc. References hold_delta(), iterator(), UniConfGen::Iter::next(), UniConfGen::Iter::rewind(), and unhold_delta(). Referenced by UniMountTreeGen::haschildren(), UniMountGen::haschildren(), UniFilterGen::haschildren(), and UniCacheGen::loadtree(). |
|
Pauses notifications until matched with a call to unhold_delta(). While paused, notification events are placed into a pending list. Redundant notifications may be discarded. Use this to safeguard non-reentrant code. Definition at line 23 of file uniconfgen.cc. Referenced by UniMountTreeGen::commit(), UniMountGen::commit(), delta(), UniClientGen::deltacb(), UniMountTreeGen::exists(), UniMountTreeGen::get(), UniMountTreeGen::haschildren(), haschildren(), UniMountTreeGen::mountgen(), UniMountGen::mountgen(), UniMountTreeGen::refresh(), UniMountGen::refresh(), UniIniGen::refresh(), UniMountTreeGen::KeyIter::rewind(), UniTempGen::set(), UniClientGen::set(), UniMountTreeGen::unmount(), UniMountGen::unmount(), and UniMountTreeGen::whichmount(). |
|
Determines if the generator is usable and working properly. The default implementation always returns true. Reimplemented in UniClientGen, UniFilterGen, UniListGen, UniPStoreGen, and UniRegistryGen. Definition at line 131 of file uniconfgen.cc. Referenced by UniFilterGen::isok(), and trymount(). |
|
Returns an iterator over the children of the specified key. Must not return NULL; consider returning a NullIter instead. The caller takes ownership of the returned iterator and is responsible for deleting it when finished. Implemented in UniClientGen, UniFilterGen, UniListGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniRegistryGen, UniSecureGen, UniTempGen, and UniWvConfGen. Referenced by haschildren(), UniMountGen::iterator(), UniFilterGen::iterator(), UniCacheGen::loadtree(), and UniMountTreeGen::KeyIter::rewind(). |
|
Refreshes information about a key recursively. May discard uncommitted data. The default implementation always returns true. Reimplemented in UniClientGen, UniConfFileTreeGen, UniFilterGen, UniIniGen, UniListGen, UniMountGen, and UniMountTreeGen. Definition at line 143 of file uniconfgen.h. Referenced by UniMountTreeGen::mountgen(), UniMountGen::mountgen(), and UniFilterGen::refresh(). |
|
Implements IObject. |
|
Stores a string value for a key into the registry. If the value is WvString::null, the key is deleted. Returns true on success. Implemented in UniCacheGen, UniClientGen, UniFilterGen, UniListGen, UniMountGen, UniMountTreeGen, UniNullGen, UniPStoreGen, UniReadOnlyGen, UniRegistryGen, UniSecureGen, UniTempGen, and UniWvConfGen. Referenced by UniMountTreeGen::set(), UniMountGen::set(), UniFilterGen::set(), UniCacheGen::set(), UniPermGen::setgroup(), UniPermGen::setowner(), and UniPermGen::setperm(). |
|
Sets the callback for change notification. Must not be reimplemented by subclasses. Definition at line 137 of file uniconfgen.cc. References UniConfGenCallback. Referenced by UniMountTreeGen::mountgen(), UniMountGen::mountgen(), UniFilterGen::setinner(), UniCacheGen::UniCacheGen(), UniConfRoot::UniConfRoot(), UniMountTreeGen::unmount(), UniMountGen::unmount(), and UniConfRoot::~UniConfRoot(). |
|
Raises an error condition.
Definition at line 57 of file uniconfgen.h. Referenced by UniClientGen::do_select(), and UniClientGen::get(). |
|
Converts a string to an integer. If the string is null or not recognized, return defvalue. This is here to support the common str2int(get(key)). The default implementation recognizes the booleans 'true', 'yes', 'on' and 'enabled' as 1, and 'false', 'no', 'off' and 'disabled' as 0. Definition at line 105 of file uniconfgen.cc. References WvFastString::cstr(), WvFastString::isnull(), and WvStringParm. |
|
Resumes notifications when each hold_delta() has been matched. On resumption, dispatches all pending notifications except those that were destined to watches that were removed. Use this to safeguard non-reentrant code. Definition at line 29 of file uniconfgen.cc. References flush_delta(). Referenced by UniMountTreeGen::commit(), UniMountGen::commit(), delta(), UniClientGen::deltacb(), UniMountTreeGen::exists(), UniMountTreeGen::get(), UniMountTreeGen::haschildren(), haschildren(), UniMountTreeGen::mountgen(), UniMountGen::mountgen(), UniMountTreeGen::refresh(), UniMountGen::refresh(), UniIniGen::refresh(), UniMountTreeGen::KeyIter::rewind(), UniTempGen::set(), UniClientGen::set(), UniMountTreeGen::unmount(), UniMountGen::unmount(), and UniMountTreeGen::whichmount(). |