ucommon::LinkedObject Class Reference

Common base class for all objects that can be formed into a linked list. More...

#include <linked.h>

Inheritance diagram for ucommon::LinkedObject:

Collaboration diagram for ucommon::LinkedObject:

Public Member Functions
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)
	Get next effective object when iterating.
bool	isMember (LinkedObject *list)
	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.

Static Public Member Functions
static unsigned	count (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.

Static Public Attributes
static LinkedObject *	inv
	Marker for invalid list pointer.
static LinkedObject *	nil
	Marker for end of linked list.

Protected Member Functions
	LinkedObject (LinkedObject **root)
	Construct base class attached to a chain of objects.
	LinkedObject ()
	Construct base class unattached to anyone.

Protected Attributes
LinkedObject *	next

Friends
class	LinkedRing
class	NamedObject
class	ObjectStack
class	OrderedIndex

---

Detailed Description

Common base class for all objects that can be formed into a linked list.

This base class is used directly for objects that can be formed into a single linked list. It is also used directly as a type for a pointer to the start of list of objects that are linked together as a list.

Author:

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

Definition at line 54 of file linked.h.

---

Constructor & Destructor Documentation

ucommon::LinkedObject::LinkedObject ( LinkedObject **  root )

protected

Construct base class attached to a chain of objects.

Parameters:

root	pointer to chain of objects we are part of.

ucommon::LinkedObject::LinkedObject ( )

protected

Construct base class unattached to anyone.

This might be used to construct intermediary base classes that may form lists through indexing objects.

---

Member Function Documentation

static unsigned ucommon::LinkedObject::count ( LinkedObject *  root )

static

Count the number of linked objects in a list.

Parameters:

root	pointer to list we are counting.

void ucommon::LinkedObject::delist

(

LinkedObject **

root

)

Locate and remove ourselves from a list of objects.

This searches the list to locate our object and if found relinks the list around us.

Parameters:

root	pointer to list we are removing ourselves from.

void ucommon::LinkedObject::enlist

(

LinkedObject **

root

)

Add our object to an existing linked list through a pointer.

This forms a container sorted in lifo order since we become the head of the list, and the previous head becomes our next.

Parameters:

root	pointer to list we are adding ourselves to.

static LinkedObject* ucommon::LinkedObject::getIndexed ( LinkedObject *  root, unsigned  index  )

static

Get member by index.

Returns:

indexed member in linked list.

Parameters:

root	pointer to list we are indexing.
index	member to find.

LinkedObject* ucommon::LinkedObject::getNext ( void  )

inline

Get next effective object when iterating.

Returns:

next linked object in list.

Reimplemented in ucommon::LinkedList, ucommon::NamedObject, ucommon::OrderedObject, and ucommon::ReusableObject.

Definition at line 139 of file linked.h.

bool ucommon::LinkedObject::isMember

(

LinkedObject *

list

)

Search to see if we are a member of a specific list.

Returns:

true if we are member of the list.

static void ucommon::LinkedObject::purge ( LinkedObject *  root )

static

Release all objects from a list.

Parameters:

root	pointer to list we are purging.

virtual void ucommon::LinkedObject::release ( void  )

virtual

Release list, mark as no longer linked.

Inherited from base Object.

Implements ucommon::ObjectProtocol.

Reimplemented in ucommon::PagerObject, and ucommon::ReusableObject.

virtual void ucommon::LinkedObject::retain ( void  )

virtual

Retain by marking as self referenced list.

Inherited from base Object.

Implements ucommon::ObjectProtocol.

---

Field Documentation

LinkedObject* ucommon::LinkedObject::nil

static

Marker for end of linked list.

Definition at line 78 of file linked.h.

---

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

• ucommon/linked.h