WvStreams
UniConfValueTree Class Reference

A plain UniConfTree that holds keys and values. More...

#include <uniconftree.h>

Inheritance diagram for UniConfValueTree:

Public Types

typedef wv::function< void(const UniConfValueTree *, void *)> Visitor
typedef wv::function< bool(const UniConfValueTree *, const UniConfValueTree *)> Comparator

Public Member Functions

 UniConfValueTree (UniConfValueTree *parent, const UniConfKey &key, WvStringParm value)
const WvStringvalue () const
 Returns the value field.
void setvalue (WvStringParm value)
 Sets the value field.
 UniConfValueTree (UniConfValueTree *parent, const UniConfKey &key, WvStringParm value)
const WvStringvalue () const
 Returns the value field.
void setvalue (WvStringParm value)
 Sets the value field.
UniConfValueTreeparent () const
 Returns a pointer to the parent node, or NULL if there is none.
void setparent (UniConfValueTree *parent)
 Reparents this node.
UniConfValueTreeroot () const
 Returns a pointer to the root node of the tree.
UniConfKey fullkey (const UniConfValueTree *ancestor=NULL) const
 Returns full path of this node relative to an ancestor.
UniConfValueTreefind (const UniConfKey &key) const
 Finds the sub-node with the specified key.
UniConfValueTreefindchild (const UniConfKey &key) const
 Finds the direct child node with the specified key.
void remove (const UniConfKey &key)
 Removes the node for the specified key from the tree and deletes it along with any of its children.
void zap ()
 Removes and deletes all children of this node.
void visit (const Visitor &visitor, void *userdata, bool preorder=true, bool postorder=false) const
 Performs a traversal on this tree using the specified visitor function and traversal type(s).
bool compare (const UniConfValueTree *other, const Comparator &comparator)
 Compares this tree with another using the specified comparator function.
const UniConfKeykey () const
 Returns the key field.
const UniConfKeykey () const
 Returns the key field.
bool haschildren () const
 Returns true if the node has children.
bool haschildren () const
 Returns true if the node has children.

Protected Types

typedef WvScatterHash< UniHashTreeBase, UniConfKey, AccessorContainer
typedef WvScatterHash< UniHashTreeBase, UniConfKey, AccessorContainer
typedef UniHashTreeBaseVisitor BaseVisitor
typedef UniHashTreeBaseVisitor BaseVisitor
typedef UniHashTreeBaseComparator BaseComparator
typedef UniHashTreeBaseComparator BaseComparator

Protected Member Functions

UniConfKey _fullkey (const UniHashTreeBase *ancestor=NULL) const
UniConfKey _fullkey (const UniHashTreeBase *ancestor=NULL) const
UniHashTreeBase_find (const UniConfKey &key) const
UniHashTreeBase_find (const UniConfKey &key) const
UniHashTreeBase_findchild (const UniConfKey &key) const
UniHashTreeBase_findchild (const UniConfKey &key) const

Static Protected Member Functions

static bool _recursivecompare (const UniHashTreeBase *a, const UniHashTreeBase *b, const UniHashTreeBaseComparator &comparator)
static bool _recursivecompare (const UniHashTreeBase *a, const UniHashTreeBase *b, const UniHashTreeBaseComparator &comparator)
static void _recursive_unsorted_visit (const UniHashTreeBase *a, const UniHashTreeBaseVisitor &visitor, void *userdata, bool preorder, bool postorder)
static void _recursive_unsorted_visit (const UniHashTreeBase *a, const UniHashTreeBaseVisitor &visitor, void *userdata, bool preorder, bool postorder)

Protected Attributes

UniHashTreeBasexparent
Container * xchildren

Detailed Description

A plain UniConfTree that holds keys and values.

Definition at line 152 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

Member Typedef Documentation

◆ Visitor

typedef wv::function<void(const UniConfValueTree*, void*)> UniConfTree< UniConfValueTree >::Visitor
inherited

◆ Comparator

typedef wv::function<bool(const UniConfValueTree*, const UniConfValueTree*)> UniConfTree< UniConfValueTree >::Comparator
inherited

◆ Container [1/2]

typedef WvScatterHash<UniHashTreeBase, UniConfKey, Accessor> UniHashTreeBase::Container
protectedinherited

◆ Container [2/2]

typedef WvScatterHash<UniHashTreeBase, UniConfKey, Accessor> UniHashTreeBase::Container
protectedinherited

Definition at line 32 of file include/unihashtree.h.

◆ BaseVisitor [1/2]

typedef UniHashTreeBaseVisitor UniHashTreeBase::BaseVisitor
protectedinherited

◆ BaseVisitor [2/2]

typedef UniHashTreeBaseVisitor UniHashTreeBase::BaseVisitor
protectedinherited

Definition at line 33 of file include/unihashtree.h.

◆ BaseComparator [1/2]

typedef UniHashTreeBaseComparator UniHashTreeBase::BaseComparator
protectedinherited

◆ BaseComparator [2/2]

typedef UniHashTreeBaseComparator UniHashTreeBase::BaseComparator
protectedinherited

Definition at line 34 of file include/unihashtree.h.

Constructor & Destructor Documentation

◆ UniConfValueTree() [1/2]

UniConfValueTree::UniConfValueTree ( UniConfValueTree * parent,
const UniConfKey & key,
WvStringParm value )
inline

◆ UniConfValueTree() [2/2]

UniConfValueTree::UniConfValueTree ( UniConfValueTree * parent,
const UniConfKey & key,
WvStringParm value )
inline

Definition at line 157 of file include/uniconftree.h.

Member Function Documentation

◆ value() [1/2]

◆ setvalue() [1/2]

void UniConfValueTree::setvalue ( WvStringParm value)
inline

Sets the value field.

Definition at line 167 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

References value().

Referenced by UniFastRegetGen::gencallback(), and UniTempGen::set().

◆ value() [2/2]

const WvString & UniConfValueTree::value ( ) const
inline

Returns the value field.

Definition at line 163 of file include/uniconftree.h.

◆ setvalue() [2/2]

void UniConfValueTree::setvalue ( WvStringParm value)
inline

Sets the value field.

Definition at line 167 of file include/uniconftree.h.

References value().

◆ parent()

UniConfValueTree * UniConfTree< UniConfValueTree >::parent ( ) const
inlineinherited

Returns a pointer to the parent node, or NULL if there is none.

Definition at line 40 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ setparent()

void UniConfTree< UniConfValueTree >::setparent ( UniConfValueTree * parent)
inlineinherited

Reparents this node.

Definition at line 44 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ root()

UniConfValueTree * UniConfTree< UniConfValueTree >::root ( ) const
inlineinherited

Returns a pointer to the root node of the tree.

Definition at line 48 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ fullkey()

UniConfKey UniConfTree< UniConfValueTree >::fullkey ( const UniConfValueTree * ancestor = NULL) const
inlineinherited

Returns full path of this node relative to an ancestor.

If ancestor is NULL, returns the root.

Definition at line 55 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ find()

UniConfValueTree * UniConfTree< UniConfValueTree >::find ( const UniConfKey & key) const
inlineinherited

Finds the sub-node with the specified key.

If key.isempty(), returns this node.

Definition at line 62 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ findchild()

UniConfValueTree * UniConfTree< UniConfValueTree >::findchild ( const UniConfKey & key) const
inlineinherited

Finds the direct child node with the specified key.

If key.numsegments() == 1, then performs the same task as find(key), but a little faster. Otherwise returns NULL.

Definition at line 71 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ remove()

void UniConfTree< UniConfValueTree >::remove ( const UniConfKey & key)
inlineinherited

Removes the node for the specified key from the tree and deletes it along with any of its children.

If the key is UniConfKey::EMPTY, deletes this object.

Definition at line 80 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ zap()

void UniConfTree< UniConfValueTree >::zap ( )
inlineinherited

Removes and deletes all children of this node.

Definition at line 84 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ visit()

void UniConfTree< UniConfValueTree >::visit ( const Visitor & visitor,
void * userdata,
bool preorder = true,
bool postorder = false ) const
inlineinherited

Performs a traversal on this tree using the specified visitor function and traversal type(s).

"visitor" is the tree visitor function "userdata" is userdata for the tree visitor function

Definition at line 108 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ compare()

bool UniConfTree< UniConfValueTree >::compare ( const UniConfValueTree * other,
const Comparator & comparator )
inlineinherited

Compares this tree with another using the specified comparator function.

Comparison of a subtree ends when the comparator returns false. "comparator" is the value compare function "userdata" is userdata for the compare function Returns: true if the comparison function returned true each time

Definition at line 124 of file debian/libwvstreams-dev/usr/include/wvstreams/uniconftree.h.

◆ key() [1/2]

const UniConfKey & UniHashTreeBase::key ( ) const
inlineinherited

Returns the key field.

Definition at line 40 of file debian/libwvstreams-dev/usr/include/wvstreams/unihashtree.h.

◆ key() [2/2]

const UniConfKey & UniHashTreeBase::key ( ) const
inlineinherited

Returns the key field.

Definition at line 40 of file include/unihashtree.h.

◆ haschildren()

bool UniHashTreeBase::haschildren ( ) const
inherited

Returns true if the node has children.

Definition at line 44 of file unihashtree.cc.

◆ _fullkey()

UniConfKey UniHashTreeBase::_fullkey ( const UniHashTreeBase * ancestor = NULL) const
protectedinherited

Definition at line 49 of file unihashtree.cc.

◆ _find()

UniHashTreeBase * UniHashTreeBase::_find ( const UniConfKey & key) const
protectedinherited

Definition at line 50 of file unihashtree.cc.

◆ _findchild()

UniHashTreeBase * UniHashTreeBase::_findchild ( const UniConfKey & key) const
protectedinherited

Definition at line 51 of file unihashtree.cc.

◆ _recursivecompare()

bool UniHashTreeBase::_recursivecompare ( const UniHashTreeBase * a,
const UniHashTreeBase * b,
const UniHashTreeBaseComparator & comparator )
staticprotectedinherited

Definition at line 53 of file unihashtree.cc.

◆ _recursive_unsorted_visit()

void UniHashTreeBase::_recursive_unsorted_visit ( const UniHashTreeBase * a,
const UniHashTreeBaseVisitor & visitor,
void * userdata,
bool preorder,
bool postorder )
staticprotectedinherited

Definition at line 57 of file unihashtree.cc.

Member Data Documentation

◆ xparent

the parent of this subtree

Definition at line 62 of file debian/libwvstreams-dev/usr/include/wvstreams/unihashtree.h.

◆ xchildren

Container * UniHashTreeBase::xchildren
protectedinherited

the hash table of children

Definition at line 63 of file debian/libwvstreams-dev/usr/include/wvstreams/unihashtree.h.


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