#include <uniinigen.h>
Inherits UniTempGen.
Collaboration diagram for UniIniGen:
To mount, use the moniker prefix "ini:" followed by the path of the .ini file.
Definition at line 23 of file uniinigen.h.
Public Member Functions | |
UniIniGen (WvStringParm filename, int _create_mode=0666) | |
Creates a generator which can load/modify/save a .ini file. | |
virtual | ~UniIniGen () |
virtual void | commit () |
Commits any changes. | |
virtual bool | refresh () |
Refreshes information about a key recursively. | |
virtual WvString | get (const UniConfKey &key) |
Fetches a string value for a key from the registry. | |
virtual void | set (const UniConfKey &key, WvStringParm value) |
Stores a string value for a key into the registry. | |
virtual bool | exists (const UniConfKey &key) |
Without fetching its value, returns true if a key exists. | |
virtual bool | haschildren (const UniConfKey &key) |
Returns true if a key has children. | |
virtual Iter * | iterator (const UniConfKey &key) |
Returns an iterator over the children of the specified key. | |
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 int | str2int (WvStringParm s, int defvalue) const |
Converts a string to an integer. | |
virtual unsigned int | addRef () |
virtual unsigned int | release () |
Public Attributes | |
UniConfValueTree * | root |
bool | dirty |
Protected Member Functions | |
void | seterror (WvStringParm error) |
Raises an error condition. |
|
Creates a generator which can load/modify/save a .ini file. "filename" is the local path of the .ini file Definition at line 41 of file uniinigen.cc. References log, UniIniGen(), and WvStringParm. Referenced by UniIniGen(). |
|
Definition at line 50 of file uniinigen.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 from UniConfGen. Definition at line 225 of file uniinigen.cc. References WvFDStream::close(), WvError::errstr(), WvError::geterr(), WvFDStream::isok(), and log. |
|
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 UniConfGen::delta(), UniConfGen::dispatch_delta(), UniConfGen::hold_delta(), and UniConfGen::unhold_delta(). Referenced by UniConfGen::delta(). |
|
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 UniConfGen::dispatch_delta(), and WvStringParm. Referenced by UniConfGen::delta(), UniConfGen::dispatch_delta(), and UniConfGen::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 from UniConfGen. Definition at line 112 of file unitempgen.cc. References UniTempGen::exists(), UniConfTree< UniConfValueTree >::find(), and UniTempGen::root. Referenced by UniTempGen::exists(). |
|
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 UniConfGen::dispatch_delta(). Referenced by UniConfGen::unhold_delta(). |
|
Fetches a string value for a key from the registry. If the key doesn't exist, the return value is WvString::null. Implements UniConfGen. Definition at line 32 of file unitempgen.cc. References UniConfTree< UniConfValueTree >::find(), UniTempGen::get(), UniTempGen::root, and UniConfValueTree::value(). Referenced by UniTempGen::get(). |
|
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 from UniConfGen. Definition at line 123 of file unitempgen.cc. References UniConfTree< UniConfValueTree >::find(), UniHashTreeBase::haschildren(), UniTempGen::haschildren(), and UniTempGen::root. Referenced by UniTempGen::haschildren(). |
|
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(), UniConfGen::delta(), UniClientGen::deltacb(), UniMountTreeGen::exists(), UniMountTreeGen::get(), UniMountTreeGen::haschildren(), UniConfGen::haschildren(), UniMountTreeGen::mountgen(), UniMountGen::mountgen(), UniMountTreeGen::refresh(), UniMountGen::refresh(), 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. Implements UniConfGen. Definition at line 134 of file unitempgen.cc. References UniConfTree< UniConfValueTree >::find(), UniTempGen::iterator(), and UniTempGen::root. Referenced by UniTempGen::iterator(). |
|
Refreshes information about a key recursively. May discard uncommitted data. The default implementation always returns true. Reimplemented from UniConfGen. Definition at line 55 of file uniinigen.cc. References WvFDStream::close(), UniConfTree< UniConfValueTree >::compare(), WvString::edit(), WvError::errstr(), WvError::geterr(), WvStream::getline(), UniConfGen::hold_delta(), UniConfKey::isempty(), WvFastString::isnull(), WvFDStream::isok(), log, WvBufBaseCommonImpl< unsigned >::peek(), WvBufBaseCommonImpl< T >::peek(), UniConfKey::prepend(), WvBufBaseCommonImpl< T >::put(), UniTempGen::root, UniTempGen::set(), trim_string(), WvBufBaseCommonImpl< T >::unalloc(), UniConfGen::unhold_delta(), WvString::unique(), UniTempGen::UniTempGen(), WvBufBaseCommonImpl< T >::used(), WvDynBuf, wvtcl_getword(), and wvtcl_unescape(). |
|
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. Implements UniConfGen. Reimplemented in UniCacheGen. Definition at line 44 of file unitempgen.cc. References UniTempGen::dirty, UniConfTree< UniConfValueTree >::find(), UniConfTree< UniConfValueTree >::findchild(), UniConfTree< UniConfValueTree >::fullkey(), UniConfGen::hold_delta(), WvFastString::isnull(), UniConfKey::Iter::next(), UniConfKey::Iter::rewind(), UniTempGen::root, UniTempGen::set(), UniConfValueTree::setvalue(), UniConfGen::unhold_delta(), UniConfValueTree::value(), and WvStringParm. Referenced by refresh(), and UniTempGen::set(). |
|
Sets the callback for change notification. Must not be reimplemented by subclasses. Definition at line 137 of file uniconfgen.cc. References UniConfGen::setcallback(). Referenced by UniMountTreeGen::mountgen(), UniMountGen::mountgen(), UniConfGen::setcallback(), 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. References UniConfGen::seterror(). Referenced by UniConfGen::seterror(). |
|
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 UniConfGen::str2int(). Referenced by UniConfGen::str2int(). |
|
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 UniConfGen::flush_delta(). Referenced by UniMountTreeGen::commit(), UniMountGen::commit(), UniConfGen::delta(), UniClientGen::deltacb(), UniMountTreeGen::exists(), UniMountTreeGen::get(), UniMountTreeGen::haschildren(), UniConfGen::haschildren(), UniMountTreeGen::mountgen(), UniMountGen::mountgen(), UniMountTreeGen::refresh(), UniMountGen::refresh(), refresh(), UniMountTreeGen::KeyIter::rewind(), UniTempGen::set(), UniClientGen::set(), UniMountTreeGen::unmount(), UniMountGen::unmount(), and UniMountTreeGen::whichmount(). |
|
set whenever the tree actually changes Definition at line 27 of file unitempgen.h. Referenced by UniTempGen::set(). |
|
the root of the tree Definition at line 26 of file unitempgen.h. Referenced by UniTempGen::exists(), UniTempGen::get(), UniTempGen::haschildren(), UniTempGen::iterator(), refresh(), UniTempGen::set(), and UniTempGen::~UniTempGen(). |