The named tree class is used to form a tree oriented list of associated objects. More...

#include <linked.h>

Inheritance diagram for ucommon::NamedTree:

Collaboration diagram for ucommon::NamedTree:

Public Member Functions
NamedTree *	find (const char *name) const
	Find a child node of our object with the specified name.

NamedTree *	getChild (const char *name) const
	Find a direct child of our node which matches the specified name.

NamedTree *	getFirst (void) const
	Get first child node in our ordered list of children.

OrderedIndex *	getIndex (void) const
	Get the ordered index of our child nodes.

NamedTree *	getIndexed (unsigned index) const
	Get child by index number.

NamedTree *	getLeaf (const char *name) const
	Find a direct leaf node on our node.

NamedTree *	getParent (void) const
	Get parent node we are listed as a child on.

bool	is_leaf (void) const
	Test if node has children.

bool	is_root (void) const
	Test if node is root node.

NamedTree *	leaf (const char *name) const
	Find a child leaf node of our object with the specified name.

	operator bool () const
	Test if this node has a name.

bool	operator! () const
	Test if this node is unnamed.

NamedTree *	path (const char *path) const
	Find a subnode by a dot separated list of node names.

void	relist (NamedTree *trunk=NULL)
	Default relist is by tail...

void	relistHead (NamedTree *trunk)
	Add leaf to a trunk, by reverse order.

void	relistTail (NamedTree *trunk)
	Add leaf to a trunk, by order.

void	remove (void)
	Remove our node from our parent list.

void	setId (char *name)
	Set or replace the name id of this node.

Public Member Functions inherited from ucommon::NamedObject
void	add (NamedObject *hash, char name, unsigned size=1)
	Add object to hash indexed list.

virtual int	compare (const char *name) const
	Compare the name of our object to see if equal.

bool	equal (const char *name) const
	Equal function which calls compare.

char *	getId (void) const
	Get the named id string of this object.

NamedObject *	getNext (void) const
	Get next effective object when iterating.

bool	operator!= (const char *name) const
	Comparison operator between our name and a string.

bool	operator== (const char *name) const
	Comparison operator between our name and a string.

Public Member Functions inherited from ucommon::OrderedObject
void	delist (OrderedIndex *index)
	Remove our ordered object from an existing index.

virtual void	enlist (OrderedIndex *index)
	List our ordered object in default strategy mode.

void	enlistHead (OrderedIndex *index)
	List our ordered object at start of a linked list on an index.

void	enlistTail (OrderedIndex *index)
	List our ordered object at end of a linked list on an index.

OrderedObject *	getNext (void) const
	Get next ordered member when iterating.

Public Member Functions inherited from ucommon::LinkedObject
void	delist (LinkedObject **root)
	Locate and remove ourselves from a list of objects.

void	enlist (LinkedObject **root)
	Add our object to an existing linked list through a pointer.

LinkedObject *	getNext (void) const
	Get next effective object when iterating.

bool	is_member (LinkedObject *list) const
	Search to see if we are a member of a specific list.

virtual void	release (void)
	Release list, mark as no longer linked.

virtual void	retain (void)
	Retain by marking as self referenced list.

Public Member Functions inherited from ucommon::ObjectProtocol
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.

	NamedTree (const NamedTree &source)
	Construct a copy of the tree.

	NamedTree (NamedTree parent, char name)
	Create a tree node as a child of an existing node.

void	purge (void)
	Performs object destruction.

virtual	~NamedTree ()
	Delete node in a tree.

Protected Member Functions inherited from ucommon::NamedObject
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.

	NamedObject (OrderedIndex index, char name)
	Created a named object on an ordered list.

	~NamedObject ()
	Destroy named object.

Protected Member Functions inherited from ucommon::OrderedObject
	OrderedObject ()
	Construct an ordered object unattached.

	OrderedObject (const OrderedObject &from)

	OrderedObject (OrderedIndex *index)
	Construct an ordered object aot end of a an index.

Protected Member Functions inherited from ucommon::LinkedObject
	LinkedObject ()
	Construct base class unattached to anyone.

	LinkedObject (const LinkedObject &from)

	LinkedObject (LinkedObject **root)
	Construct base class attached to a chain of objects.

Protected Attributes
OrderedIndex	Child

NamedTree *	Parent

Protected Attributes inherited from ucommon::NamedObject
char *	Id

Protected Attributes inherited from ucommon::LinkedObject
LinkedObject *	Next

Additional Inherited Members
Static Public Member Functions inherited from ucommon::NamedObject
static unsigned	count (NamedObject **hash, unsigned size)
	Count the total named objects in a hash table.

static NamedObject *	find (NamedObject root, const char name)
	Find a named object from a simple list.

static NamedObject **	index (NamedObject **hash, unsigned size)
	Convert a hash index into a linear object pointer array.

static unsigned	keyindex (const char *name, unsigned size)
	Internal function to convert a name to a hash index number.

static NamedObject *	map (NamedObject *hash, const char name, unsigned size)
	Find a named object through a hash map table.

static void	purge (NamedObject **hash, unsigned size)
	Purge a hash indexed table of named objects.

static NamedObject *	remove (NamedObject *hash, const char name, unsigned size)
	Remove an object from a hash map table.

static NamedObject *	remove (NamedObject *root, const char name)
	Remove a named object from a simple list.

static NamedObject *	skip (NamedObject *hash, NamedObject current, unsigned size)
	Iterate through a hash map table.

static NamedObject **	sort (NamedObject **list, size_t count=0)
	Sort an array of named objects in alphabetical order.

Static Public Member Functions inherited from ucommon::LinkedObject
static unsigned	count (const LinkedObject *root)
	Count the number of linked objects in a list.

static LinkedObject *	getIndexed (LinkedObject *root, unsigned index)
	Get member by index.

static void	purge (LinkedObject *root)
	Release all objects from a list.

Detailed Description

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.

Author: David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 575 of file linked.h.

Constructor & Destructor Documentation

◆ NamedTree() [1/3]

ucommon::NamedTree::NamedTree ( char * name = NULL )

protected

Create a stand-alone or root tree node, with an optional name.

Parameters

name	for this node.

◆ NamedTree() [2/3]

ucommon::NamedTree::NamedTree	(	NamedTree *	parent,
		char *	name )

protected

Create a tree node as a child of an existing node.

Parameters

parent	node we are listed under.
name	of our node.

◆ NamedTree() [3/3]

ucommon::NamedTree::NamedTree ( const NamedTree & source )

protected

Construct a copy of the tree.

Parameters

source object to copy from.

◆ ~NamedTree()

virtual ucommon::NamedTree::~NamedTree ( )

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.

Member Function Documentation

◆ find()

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.

Parameters

name	to search for.

Returns: tree object found or NULL.

◆ getChild()

NamedTree * ucommon::NamedTree::getChild ( const char * name ) const

Find a direct child of our node which matches the specified name.

Parameters

name	of child node to find.

Returns: tree node object of child or NULL.

◆ getFirst()

NamedTree * ucommon::NamedTree::getFirst ( void ) const

inline

Get first child node in our ordered list of children.

This might be used to iterate child nodes. This may also be used to get unamed child nodes.

Returns: first child node or NULL if no children.

Definition at line 667 of file linked.h.

Here is the call graph for this function:

◆ getIndex()

OrderedIndex * ucommon::NamedTree::getIndex ( void ) const

inline

Get the ordered index of our child nodes.

Returns: ordered index of our children.

Definition at line 692 of file linked.h.

◆ getIndexed()

NamedTree * ucommon::NamedTree::getIndexed ( unsigned index ) const

inline

Get child by index number.

Parameters

index of child to fetch.

Returns: indexed child node.

Definition at line 684 of file linked.h.

Here is the call graph for this function:

◆ getLeaf()

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.

Parameters

name	of leaf child node to find.

Returns: tree node object of leaf or NULL.

◆ getParent()

NamedTree * ucommon::NamedTree::getParent ( void ) const

inline

Get parent node we are listed as a child on.

Returns: parent node or NULL if none.

Definition at line 675 of file linked.h.

◆ is_leaf()

bool ucommon::NamedTree::is_leaf ( void ) const

inline

Test if node has children.

Returns: true if node contains child nodes.

Definition at line 729 of file linked.h.

Here is the call graph for this function:

◆ is_root()

bool ucommon::NamedTree::is_root ( void ) const

inline

Test if node is root node.

Returns: true if node is root node.

Definition at line 737 of file linked.h.

◆ leaf()

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.

Parameters

name	of leaf node to search for.

Returns: tree node object found or NULL.

◆ operator bool()

ucommon::NamedTree::operator bool ( ) const

inline

Test if this node has a name.

Returns: true if name is set.

Definition at line 700 of file linked.h.

◆ operator!()

bool ucommon::NamedTree::operator! ( ) const

inline

Test if this node is unnamed.

Returns: false if name is set.

Definition at line 708 of file linked.h.

◆ path()

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.

Parameters

path	name string being sought.

Returns: tree node object found at the path or NULL.

◆ purge()

void ucommon::NamedTree::purge ( void )

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.

◆ relist()

void ucommon::NamedTree::relist ( NamedTree * trunk = NULL )

inline

Default relist is by tail...

Parameters

trunk we add leaf node to, NULL to delist.

Definition at line 757 of file linked.h.

◆ relistHead()

void ucommon::NamedTree::relistHead ( NamedTree * trunk )

Add leaf to a trunk, by reverse order.

If NULL, just remove.

Parameters

trunk we add leaf node to.

◆ relistTail()

void ucommon::NamedTree::relistTail ( NamedTree * trunk )

Add leaf to a trunk, by order.

If NULL, just remove.

Parameters

trunk we add leaf node to.

◆ remove()

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.

◆ setId()

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.

Parameters

name	for this node to set.

Field Documentation

◆ Child

OrderedIndex ucommon::NamedTree::Child

protected

Definition at line 579 of file linked.h.

◆ Parent

NamedTree* ucommon::NamedTree::Parent

protected

Definition at line 578 of file linked.h.

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

/builddir/build/BUILD/commoncpp-7.0.1/inc/ucommon/linked.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NamedTree() [1/3]

◆ NamedTree() [2/3]

◆ NamedTree() [3/3]

◆ ~NamedTree()

Member Function Documentation

◆ find()

◆ getChild()

◆ getFirst()

◆ getIndex()

◆ getIndexed()

◆ getLeaf()

◆ getParent()

◆ is_leaf()

◆ is_root()

◆ leaf()

◆ operator bool()

◆ operator!()

◆ path()

◆ purge()

◆ relist()

◆ relistHead()

◆ relistTail()

◆ remove()

◆ setId()

Field Documentation

◆ Child

◆ Parent