UCommon
|
The named tree class is used to form a tree oriented list of associated objects. More...
#include <linked.h>
Public Member Functions | |
NamedTree * | find (const char *name) const |
Find a child node of our object with the specified name. More... | |
NamedTree * | getChild (const char *name) const |
Find a direct child of our node which matches the specified name. More... | |
NamedTree * | getFirst (void) const |
Get first child node in our ordered list of children. More... | |
OrderedIndex * | getIndex (void) const |
Get the ordered index of our child nodes. More... | |
NamedTree * | getIndexed (unsigned index) const |
Get child by index number. More... | |
NamedTree * | getLeaf (const char *name) const |
Find a direct leaf node on our node. More... | |
NamedTree * | getParent (void) const |
Get parent node we are listed as a child on. More... | |
bool | is_leaf (void) const |
Test if node has children. More... | |
bool | is_root (void) const |
Test if node is root node. More... | |
NamedTree * | leaf (const char *name) const |
Find a child leaf node of our object with the specified name. More... | |
operator bool () const | |
Test if this node has a name. More... | |
bool | operator! () const |
Test if this node is unnamed. More... | |
NamedTree * | path (const char *path) const |
Find a subnode by a dot separated list of node names. More... | |
void | relist (NamedTree *trunk=NULL) |
Default relist is by tail... More... | |
void | relistHead (NamedTree *trunk) |
Add leaf to a trunk, by reverse order. More... | |
void | relistTail (NamedTree *trunk) |
Add leaf to a trunk, by order. More... | |
void | remove (void) |
Remove our node from our parent list. More... | |
void | setId (char *name) |
Set or replace the name id of this node. More... | |
![]() | |
void | add (NamedObject **hash, char *name, unsigned size=1) |
Add object to hash indexed list. More... | |
virtual int | compare (const char *name) const |
Compare the name of our object to see if equal. More... | |
bool | equal (const char *name) const |
Equal function which calls compare. More... | |
char * | getId (void) const |
Get the named id string of this object. More... | |
NamedObject * | getNext (void) const |
Get next effective object when iterating. More... | |
bool | operator!= (const char *name) const |
Comparison operator between our name and a string. More... | |
bool | operator== (const char *name) const |
Comparison operator between our name and a string. 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. | |
Protected Member Functions | |
NamedTree (char *name=NULL) | |
Create a stand-alone or root tree node, with an optional name. More... | |
NamedTree (NamedTree *parent, char *name) | |
Create a tree node as a child of an existing node. More... | |
NamedTree (const NamedTree &source) | |
Construct a copy of the tree. More... | |
void | purge (void) |
Performs object destruction. More... | |
virtual | ~NamedTree () |
Delete node in a tree. More... | |
![]() | |
virtual void | clearId (void) |
The behavior of clearing id's can be overridden if they are not assigned as strdup's from the heap... | |
NamedObject () | |
Create an empty unnamed cell object. | |
NamedObject (NamedObject **hash, char *name, unsigned size=1) | |
Create a named object and add to hash indexed list. More... | |
NamedObject (OrderedIndex *index, char *name) | |
Created a named object on an ordered list. More... | |
~NamedObject () | |
Destroy named object. 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) | |
Protected Attributes | |
OrderedIndex | Child |
NamedTree * | Parent |
![]() | |
char * | Id |
![]() | |
LinkedObject * | Next |
Additional Inherited Members | |
![]() | |
static unsigned | count (NamedObject **hash, unsigned size) |
Count the total named objects in a hash table. More... | |
static NamedObject * | find (NamedObject *root, const char *name) |
Find a named object from a simple list. More... | |
static NamedObject ** | index (NamedObject **hash, unsigned size) |
Convert a hash index into a linear object pointer array. More... | |
static unsigned | keyindex (const char *name, unsigned size) |
Internal function to convert a name to a hash index number. More... | |
static NamedObject * | map (NamedObject **hash, const char *name, unsigned size) |
Find a named object through a hash map table. More... | |
static void | purge (NamedObject **hash, unsigned size) |
Purge a hash indexed table of named objects. More... | |
static NamedObject * | remove (NamedObject **root, const char *name) |
Remove a named object from a simple list. More... | |
static NamedObject * | remove (NamedObject **hash, const char *name, unsigned size) |
Remove an object from a hash map table. More... | |
static NamedObject * | skip (NamedObject **hash, NamedObject *current, unsigned size) |
Iterate through a hash map table. More... | |
static NamedObject ** | sort (NamedObject **list, size_t count=0) |
Sort an array of named objects in alphabetical order. More... | |
![]() | |
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... | |
The named tree class is used to form a tree oriented list of associated objects.
Typical uses for such data structures might be to form a parsed XML document, or for forming complex configuration management systems or for forming system resource management trees.
|
protected |
Create a stand-alone or root tree node, with an optional name.
name | for this node. |
|
protected |
Create a tree node as a child of an existing node.
parent | node we are listed under. |
name | of our node. |
|
protected |
Construct a copy of the tree.
source | object to copy from. |
|
protectedvirtual |
Delete node in a tree.
If we delete a node, we must delist it from it's parent. We must also delink any child nodes. This is done by calling the purge() member.
NamedTree* ucommon::NamedTree::find | ( | const char * | name | ) | const |
Find a child node of our object with the specified name.
This will also recursivily search all child nodes that have children until the named node can be found. This seeks a child node that has children.
name | to search for. |
NamedTree* ucommon::NamedTree::getChild | ( | const char * | name | ) | const |
Find a direct child of our node which matches the specified name.
name | of child node to find. |
|
inline |
|
inline |
|
inline |
NamedTree* ucommon::NamedTree::getLeaf | ( | const char * | name | ) | const |
Find a direct leaf node on our node.
A leaf node is a node that has no children of it's own. This does not perform a recursive search.
name | of leaf child node to find. |
|
inline |
|
inline |
|
inline |
NamedTree* ucommon::NamedTree::leaf | ( | const char * | name | ) | const |
Find a child leaf node of our object with the specified name.
This will recursively search all our child nodes until it can find a leaf node containing the specified id but that holds no further children.
name | of leaf node to search for. |
|
inline |
|
inline |
NamedTree* ucommon::NamedTree::path | ( | const char * | path | ) | const |
Find a subnode by a dot separated list of node names.
If one or more lead dots are used, then the search will go through parent node levels of our node. The dot separated list could be thought of as a kind of pathname where dot is used like slash. This implies that individual nodes can never use names which contain dot's if the path function will be used.
path | name string being sought. |
|
protected |
Performs object destruction.
Note, if we delete a named tree object the name of our member object is assumed to be a dynamically allocated string that will also be free'd.
|
inline |
void ucommon::NamedTree::relistHead | ( | NamedTree * | trunk | ) |
Add leaf to a trunk, by reverse order.
If NULL, just remove.
trunk | we add leaf node to. |
void ucommon::NamedTree::relistTail | ( | NamedTree * | trunk | ) |
Add leaf to a trunk, by order.
If NULL, just remove.
trunk | we add leaf node to. |
void ucommon::NamedTree::remove | ( | void | ) |
Remove our node from our parent list.
The name is set to NULL to keep delete from freeing the name string.
void ucommon::NamedTree::setId | ( | char * | name | ) |
Set or replace the name id of this node.
This will free the string if a name had already been set.
name | for this node to set. |