A smart pointer template for iterating linked lists. More...

#include <linked.h>

Public Member Functions
T *	getNext (void) const
	Get the next member in linked list. More...

T *	getPrev (void) const
	Get the previous member in double linked list. More...

bool	is () const

bool	is_next (void) const
	Test for next member in linked list. More...

bool	is_prev (void) const
	Test for previous member in double linked list. More...

	linked_pointer ()
	Create a linked pointer not attached to a list. More...

	linked_pointer (const linked_pointer &pointer)
	Create a copy of an existing linked pointer. More...

	linked_pointer (const LinkedObject *pointer)

	linked_pointer (LinkedObject *pointer)
	Create a linked pointer assigned from a raw linked object pointer. More...

	linked_pointer (OrderedIndex *index)
	Create a linked pointer to examine an ordered index. More...

	linked_pointer (T *pointer)
	Create a linked pointer and assign to start of a list. More...

void	next (void)
	Move (iterate) pointer to next member in linked list. More...

	operator bool () const
	Test if linked pointer is set/we are not at end of list. More...

	operator T* () const
	Return object we point to by casting. More...

bool	operator! () const
	Test if linked list is empty/we are at end of list. More...

T *	operator* () const
	Return object we currently point to. More...

void	operator++ ()
	Move (iterate) pointer to next member in linked list. More...

void	operator-- ()
	Move (iterate) pointer to previous member in double linked list. More...

T *	operator-> () const
	Return member from typed object our pointer references. More...

void	operator= (linked_pointer &pointer)
	Assign our pointer from another pointer. More...

void	operator= (LinkedObject *pointer)
	Assign our pointer from a generic linked object pointer. More...

void	operator= (OrderedIndex *index)
	Assign our pointer from the start of an ordered index. More...

void	operator= (T *pointer)
	Assign our typed iterative pointer from a matching typed object. More...

void	prev (void)
	Move (iterate) pointer to previous member in double linked list. More...

LinkedObject **	root (void) const
	Return pointer to our linked pointer to use as root node of a chain. More...

Detailed Description

template<class T>
class ucommon::linked_pointer< T >

A smart pointer template for iterating linked lists.

This class allows one to access a list of single or double linked objects and iterate through each member of a list.

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

Definition at line 991 of file linked.h.

Constructor & Destructor Documentation

◆ linked_pointer() [1/6]

template<class T >

ucommon::linked_pointer< T >::linked_pointer ( T * pointer )

inline

Create a linked pointer and assign to start of a list.

Parameters

pointer to first member of a linked list.

Definition at line 1001 of file linked.h.

◆ linked_pointer() [2/6]

template<class T >

ucommon::linked_pointer< T >::linked_pointer ( const linked_pointer< T > & pointer )

inline

Create a copy of an existing linked pointer.

Parameters

pointer to copy from.

Definition at line 1009 of file linked.h.

◆ linked_pointer() [3/6]

template<class T >

ucommon::linked_pointer< T >::linked_pointer ( LinkedObject * pointer )

inline

Create a linked pointer assigned from a raw linked object pointer.

Parameters

pointer to linked object.

Definition at line 1017 of file linked.h.

◆ linked_pointer() [4/6]

template<class T >

ucommon::linked_pointer< T >::linked_pointer ( const LinkedObject * pointer )

inline

Definition at line 1021 of file linked.h.

◆ linked_pointer() [5/6]

template<class T >

ucommon::linked_pointer< T >::linked_pointer ( OrderedIndex * index )

inline

Create a linked pointer to examine an ordered index.

Parameters

index of linked objects to iterate through.

Definition at line 1029 of file linked.h.

Here is the call graph for this function:

◆ linked_pointer() [6/6]

template<class T >

ucommon::linked_pointer< T >::linked_pointer ( )

inline

Create a linked pointer not attached to a list.

Definition at line 1036 of file linked.h.

Member Function Documentation

◆ getNext()

template<class T >

T * ucommon::linked_pointer< T >::getNext ( void ) const

inline

Get the next member in linked list.

Do not change who we point to.

Returns: next member in list or NULL if end of list.

Definition at line 1114 of file linked.h.

◆ getPrev()

template<class T >

T * ucommon::linked_pointer< T >::getPrev ( void ) const

inline

Get the previous member in double linked list.

Do not change who we point to.

Returns: previous member in list or NULL if start of list.

Definition at line 1123 of file linked.h.

◆ is()

template<class T >

bool ucommon::linked_pointer< T >::is ( ) const

inline

Definition at line 1173 of file linked.h.

◆ is_next()

template<class T >

bool ucommon::linked_pointer< T >::is_next ( void ) const

inline

Test for next member in linked list.

Returns: true if there is more members after current one.

Definition at line 1145 of file linked.h.

◆ is_prev()

template<class T >

bool ucommon::linked_pointer< T >::is_prev ( void ) const

inline

Test for previous member in double linked list.

Returns: true if there is more members before current one.

Definition at line 1153 of file linked.h.

◆ next()

template<class T >

void ucommon::linked_pointer< T >::next ( void )

inline

Move (iterate) pointer to next member in linked list.

Definition at line 1106 of file linked.h.

◆ operator bool()

template<class T >

ucommon::linked_pointer< T >::operator bool ( ) const

inline

Test if linked pointer is set/we are not at end of list.

Returns: true if we are not at end of list.

Definition at line 1161 of file linked.h.

◆ operator T*()

template<class T >

ucommon::linked_pointer< T >::operator T* ( ) const

inline

Return object we point to by casting.

Returns: object linked pointer references.

Definition at line 1092 of file linked.h.

◆ operator!()

template<class T >

bool ucommon::linked_pointer< T >::operator! ( ) const

inline

Test if linked list is empty/we are at end of list.

Returns: true if we are at end of list.

Definition at line 1169 of file linked.h.

◆ operator*()

template<class T >

T * ucommon::linked_pointer< T >::operator* ( ) const

inline

Return object we currently point to.

Returns: object linked pointer references.

Definition at line 1084 of file linked.h.

◆ operator++()

template<class T >

void ucommon::linked_pointer< T >::operator++ ( void )

inline

Move (iterate) pointer to next member in linked list.

Definition at line 1130 of file linked.h.

◆ operator--()

template<class T >

void ucommon::linked_pointer< T >::operator-- ( void )

inline

Move (iterate) pointer to previous member in double linked list.

Definition at line 1137 of file linked.h.

◆ operator->()

template<class T >

T * ucommon::linked_pointer< T >::operator-> ( ) const

inline

Return member from typed object our pointer references.

Returns: evaluated member of object we point to.

Definition at line 1076 of file linked.h.

◆ operator=() [1/4]

template<class T >

void ucommon::linked_pointer< T >::operator= ( linked_pointer< T > & pointer )

inline

Assign our pointer from another pointer.

Parameters

pointer to assign from.

Definition at line 1052 of file linked.h.

◆ operator=() [2/4]

template<class T >

void ucommon::linked_pointer< T >::operator= ( LinkedObject * pointer )

inline

Assign our pointer from a generic linked object pointer.

Parameters

pointer of linked list.

Definition at line 1068 of file linked.h.

◆ operator=() [3/4]

template<class T >

void ucommon::linked_pointer< T >::operator= ( OrderedIndex * index )

inline

Assign our pointer from the start of an ordered index.

Parameters

index to assign pointer from.

Definition at line 1060 of file linked.h.

Here is the call graph for this function:

◆ operator=() [4/4]

template<class T >

void ucommon::linked_pointer< T >::operator= ( T * pointer )

inline

Assign our typed iterative pointer from a matching typed object.

Parameters

pointer to typed object.

Definition at line 1044 of file linked.h.

◆ prev()

template<class T >

void ucommon::linked_pointer< T >::prev ( void )

inline

Move (iterate) pointer to previous member in double linked list.

Definition at line 1099 of file linked.h.

◆ root()

template<class T >

LinkedObject ** ucommon::linked_pointer< T >::root ( void ) const

inline

Return pointer to our linked pointer to use as root node of a chain.

Returns: our object pointer as a root index.

Definition at line 1181 of file linked.h.

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

/builddir/build/BUILD/ucommon-7.0.0/inc/ucommon/linked.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ linked_pointer() [1/6]

◆ linked_pointer() [2/6]

◆ linked_pointer() [3/6]

◆ linked_pointer() [4/6]

◆ linked_pointer() [5/6]

◆ linked_pointer() [6/6]

Member Function Documentation

◆ getNext()

◆ getPrev()

◆ is()

◆ is_next()

◆ is_prev()

◆ next()

◆ operator bool()

◆ operator T*()

◆ operator!()

◆ operator*()

◆ operator++()

◆ operator--()

◆ operator->()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ prev()

◆ root()