WvStreams
Public Types | Public Member Functions | Public Attributes | Protected Member Functions
UniIniGen Class Reference

Loads and saves ".ini"-style files similar to those used by Windows, but adapted to represent keys and values using Tcl style lists. More...

#include <uniinigen.h>

Inheritance diagram for UniIniGen:
Inheritance graph
[legend]

List of all members.

Public Types

typedef wv::function< void()> SaveCallback
typedef ::UniListIter ListIter
 An iterator over a constant list of keys (see below)

Public Member Functions

 UniIniGen (WvStringParm filename, int _create_mode=0666, SaveCallback _save_cb=SaveCallback())
 Creates a generator which can load/modify/save a .ini file.
virtual void commit ()
 Commits any changes.
virtual bool refresh ()
 Refreshes information about a key recursively.
virtual void set (const UniConfKey &key, WvStringParm value)
 Stores a string value for a key into the registry.
virtual WvString get (const UniConfKey &key)
 Fetches a string value for a key from the registry.
virtual void setv (const UniConfPairList &pairs)
 Stores multiple key-value pairs into the registry.
virtual void flush_buffers ()
 Flushes any commitment/notification buffers .
virtual bool haschildren (const UniConfKey &key)
 Returns true if a key has children.
virtual Iteriterator (const UniConfKey &key)
 Returns an iterator over the children of the specified key.
virtual void add_callback (void *cookie, const UniConfGenCallback &callback)
 Adds a callback for change notification.
virtual void del_callback (void *cookie)
 Removes a 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 prefetch (const UniConfKey &key, bool recursive)
 Indicate that we will eventually be interested in doing get(), haschildren(), or other "get-like" operations on a particular key or tree of keys.
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 Iterrecursiveiterator (const UniConfKey &key)
 Like iterator(), but the returned iterator is recursive, that is, it will return children of the immediate children, not just the immediate children themselves.
virtual unsigned int addRef ()=0
 Indicate you are using this object.
virtual unsigned int release ()=0
 Indicate that you are finished using this object.
virtual IObjectgetInterface (const UUID &)=0
 Returns the requested XPLC interface.
virtual IWeakRefgetWeakRef ()=0
 Return a weak reference to this object.

Public Attributes

UniConfValueTreeroot
bool dirty

Protected Member Functions

void notify_deleted (const UniConfValueTree *node, void *)
void setv_naive (const UniConfPairList &pairs)

Detailed Description

Loads and saves ".ini"-style files similar to those used by Windows, but adapted to represent keys and values using Tcl style lists.

To mount, use the moniker prefix "ini:" followed by the path of the .ini file.

Definition at line 25 of file uniinigen.h.


Constructor & Destructor Documentation

UniIniGen::UniIniGen ( WvStringParm  filename,
int  _create_mode = 0666,
UniIniGen::SaveCallback  _save_cb = SaveCallback() 
)

Creates a generator which can load/modify/save a .ini file.

"filename" is the local path of the .ini file

Definition at line 30 of file uniinigen.cc.

References UniConfKey::EMPTY, and set().


Member Function Documentation

void UniIniGen::commit ( ) [virtual]

Commits any changes.

The default implementation does nothing.

Reimplemented from UniTempGen.

Definition at line 294 of file uniinigen.cc.

References WvFdStream::close(), UniTempGen::dirty, WvErrorBase::geterr(), WvFdStream::getwfd(), and UniTempGen::root.

bool UniIniGen::refresh ( ) [virtual]
void UniIniGen::set ( const UniConfKey key,
WvStringParm  value 
) [virtual]

Stores a string value for a key into the registry.

If the value is WvString::null, the key is deleted.

Reimplemented from UniTempGen.

Definition at line 39 of file uniinigen.cc.

References UniConfKey::EMPTY, UniConfKey::isempty(), WvFastString::isnull(), and UniTempGen::set().

Referenced by UniIniGen().

WvString UniTempGen::get ( const UniConfKey key) [virtual, inherited]

Fetches a string value for a key from the registry.

If the key doesn't exist, the return value has .isnull() == true.

Implements UniConfGen.

Reimplemented in UniCallbackGen, and UniCacheGen.

Definition at line 38 of file unitempgen.cc.

References UniConfTree< Sub >::find(), UniConfKey::isempty(), UniConfKey::last(), UniTempGen::root, and UniConfValueTree::value().

void UniTempGen::setv ( const UniConfPairList &  pairs) [virtual, inherited]

Stores multiple key-value pairs into the registry.

If the value is WvString::null, the key is deleted.

Implements UniConfGen.

Definition at line 150 of file unitempgen.cc.

virtual void UniTempGen::flush_buffers ( ) [inline, virtual, inherited]

Flushes any commitment/notification buffers .

The default implementation always returns true. NOTE: This method should be 'protected'

Implements UniConfGen.

Definition at line 36 of file unitempgen.h.

bool UniTempGen::haschildren ( const UniConfKey key) [virtual, inherited]

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 156 of file unitempgen.cc.

References UniConfTree< Sub >::find(), UniHashTreeBase::haschildren(), and UniTempGen::root.

UniConfGen::Iter * UniTempGen::iterator ( const UniConfKey key) [virtual, inherited]

Returns an iterator over the children of the specified key.

May return NULL or an empty iterator if the key has no children.

The caller takes ownership of the returned iterator and is responsible for deleting it when finished.

Implements UniConfGen.

Definition at line 167 of file unitempgen.cc.

References UniListIter::add(), UniConfTree< Sub >::find(), and UniTempGen::root.

void UniConfGen::add_callback ( void *  cookie,
const UniConfGenCallback &  callback 
) [virtual, inherited]

Adds a callback for change notification.

Must *not* be reimplemented by subclasses of UniConfGen.

Implements IUniConfGen.

Definition at line 158 of file uniconfgen.cc.

Referenced by UniConfRoot::UniConfRoot().

void UniConfGen::del_callback ( void *  cookie) [virtual, inherited]

Removes a callback for change notification.

Implements IUniConfGen.

Definition at line 165 of file uniconfgen.cc.

Referenced by UniConfRoot::~UniConfRoot().

void UniConfGen::dispatch_delta ( const UniConfKey key,
WvStringParm  value 
) [inherited]

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 71 of file uniconfgen.cc.

Referenced by UniConfGen::delta(), and UniConfGen::flush_delta().

void UniConfGen::hold_delta ( ) [inherited]

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 32 of file uniconfgen.cc.

Referenced by UniTransactionGen::commit(), UniMountGen::commit(), UniConfGen::delta(), UniConfGen::haschildren(), UniMountGen::mountgen(), refresh(), UniTransactionGen::refresh(), UniMountGen::refresh(), UniTempGen::set(), UniClientGen::set(), UniTransactionGen::set(), UniClientGen::setv(), UniTransactionGen::setv(), and UniMountGen::unmount().

void UniConfGen::unhold_delta ( ) [inherited]

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 38 of file uniconfgen.cc.

References UniConfGen::flush_delta().

Referenced by UniTransactionGen::commit(), UniMountGen::commit(), UniConfGen::delta(), UniConfGen::haschildren(), UniMountGen::mountgen(), refresh(), UniTransactionGen::refresh(), UniMountGen::refresh(), UniTempGen::set(), UniClientGen::set(), UniTransactionGen::set(), UniClientGen::setv(), UniTransactionGen::setv(), and UniMountGen::unmount().

void UniConfGen::clear_delta ( ) [inherited]

Clears the list of pending notifications without sending them.

Does not affect the hold nesting count.

Definition at line 47 of file uniconfgen.cc.

void UniConfGen::flush_delta ( ) [inherited]

Flushes the list of pending notifications by sending them.

Does not affect the hold nesting count.

Definition at line 53 of file uniconfgen.cc.

References UniConfGen::dispatch_delta().

Referenced by UniConfGen::unhold_delta().

void UniConfGen::delta ( const UniConfKey key,
WvStringParm  value 
) [inherited]
bool UniConfGen::isok ( ) [virtual, inherited]

Determines if the generator is usable and working properly.

The default implementation always returns true.

Implements IUniConfGen.

Reimplemented in UniTransactionGen, UniRetryGen, UniFilterGen, UniReplicateGen, UniPStoreGen, UniClientGen, UniUnwrapGen, UniListGen, UniCacheGen, and UniRegistryGen.

Definition at line 152 of file uniconfgen.cc.

virtual void UniConfGen::prefetch ( const UniConfKey key,
bool  recursive 
) [inline, virtual, inherited]

Indicate that we will eventually be interested in doing get(), haschildren(), or other "get-like" operations on a particular key or tree of keys.

The generator may be able to speed up these operations by, say, caching them in advance.

This function is not allowed to do blocking operations. It is allowed to do nothing at all, however, and then get() might block later.

Implements IUniConfGen.

Reimplemented in UniRetryGen, UniFilterGen, and UniUnwrapGen.

Definition at line 282 of file uniconfgen.h.

bool UniConfGen::exists ( const UniConfKey key) [virtual, inherited]

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().

Implements IUniConfGen.

Reimplemented in UniMountGen, UniRetryGen, UniFilterGen, UniPStoreGen, UniUnwrapGen, UniSecureGen, UniListGen, UniRegistryGen, UniFastRegetGen, and UniSlowGen.

Definition at line 120 of file uniconfgen.cc.

int UniConfGen::str2int ( WvStringParm  s,
int  defvalue 
) const [virtual, inherited]

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.

Implements IUniConfGen.

Definition at line 126 of file uniconfgen.cc.

References WvFastString::cstr(), and WvFastString::isnull().

UniConfGen::Iter * UniConfGen::recursiveiterator ( const UniConfKey key) [virtual, inherited]

Like iterator(), but the returned iterator is recursive, that is, it will return children of the immediate children, not just the immediate children themselves.

May return NULL if the key has no immediate children (since that means there are also no indirect children).

Note that UniConfGen::recursiveiterator() is a default implementation that just calls iterator() recursively, so it'll work in any derived class without you overriding this function. However, you might want to do it anyway if it would be more efficient in your particular case.

Implements IUniConfGen.

Reimplemented in UniMountGen, UniRetryGen, UniFilterGen, UniClientGen, UniAutoMountGen, UniUnwrapGen, UniSecureGen, and UniSlowGen.

Definition at line 260 of file uniconfgen.cc.

virtual unsigned int IObject::addRef ( ) [pure virtual, inherited]

Indicate you are using this object.

This increases the reference count of the object by one. Usually, when the reference count reaches zero, the object is freed automatically.

This called a "strong reference", because they will prevent the object from being destroyed. They should thus be used carefully, as they control the lifetime of the object. For example, you do not need to call addRef() on object passed as parameters, unless you intend on keeping them.

addRef() is often called automatically for you in XPLC, but you'll have to call release() by hand sometimes unless you use xplc_ptr.

Referenced by WvIStreamList::execute(), IObjectImplInternal::getInterface(), StaticServiceHandler::getObject(), WeakRef::getObject(), WvIStreamList::post_select(), WvQtStreamClone::WvQtStreamClone(), and WvSSLStream::WvSSLStream().

virtual unsigned int IObject::release ( ) [pure virtual, inherited]

Indicate that you are finished using this object.

This decreases the reference count of the object by one. Usually, when the reference count reaches zero, the object is freed automatically.

You will usually need to manually release() any object given to you by any other XPLC function, unless you give the object to someone else who will call release.

If you use xplc_ptr, it will do this for you.

Referenced by WvIStreamList::execute(), mutate(), NewMoniker::resolve(), and MonikerService::resolve().

virtual IObject* IObject::getInterface ( const UUID ) [pure virtual, inherited]

Returns the requested XPLC interface.

Will return NULL if the interface is not supported. The returned interface has been addRef()ed, so you will need to release() it when done. Note that the interface returned may be a pointer to the same object or a different one - that's none of your business. Asking for the IObject interface should always return the same pointer for a given logical object, so this can be used for comparison by identity.

You should probably use the convenient mutate() and get() functions instead of this, or use an xplc_ptr, which mutates the object for you.

Referenced by mutate().

virtual IWeakRef* IObject::getWeakRef ( ) [pure virtual, inherited]

Return a weak reference to this object.

A weak reference points at the object, but does not control the lifetime of the object. An object can thus still be deleted while someone holds a weak reference. You will still need to release() the weak reference when you are done with it.

See also:
IWeakRef

Member Data Documentation

the root of the tree

Definition at line 25 of file unitempgen.h.

Referenced by commit(), UniTempGen::get(), UniTempGen::haschildren(), UniTempGen::iterator(), refresh(), and UniTempGen::set().

bool UniTempGen::dirty [inherited]

set whenever the tree actually changes

Definition at line 26 of file unitempgen.h.

Referenced by commit(), refresh(), and UniTempGen::set().


The documentation for this class was generated from the following files: