cslist.h File Reference

Detailed Description

This file defines a C-based interfaces for Singly lists that do not use or require dynamic memory allocation.

See the 'README.txt' file for details on how intrusive containers work.

NOTE: The list operations are NOT type safe - it the Application's responsibility for managing the types/content of the lists

#include "Cpl/Container/citem.h"

Include dependency graph for cslist.h:

Go to the source code of this file.

Classes
struct	CplContainerSList_T
	This structure define the internal structure of a Singly Linked List. More...

Typedefs
typedef struct CplContainerSList_T	CplContainerSList_T
	This structure define the internal structure of a Singly Linked List.

Functions
void	Cpl_Container_SList_initialize (CplContainerSList_T *listToInitialize)
	Initializes the list.
void	Cpl_Container_SList_move (CplContainerSList_T *dstList, CplContainerSList_T *srcList)
	Moves the content of 'srcList' to the 'dstList'.
void	Cpl_Container_SList_clear (CplContainerSList_T *listToClear)
	Empties the list.
void *	Cpl_Container_SList_get (CplContainerSList_T *list)
	Removes the FIRST item in the list.
void *	Cpl_Container_SList_getLast (CplContainerSList_T *list)
	Removes the LAST item in the list.
bool	Cpl_Container_SList_put (CplContainerSList_T *list, void *item)
	Adds the item as the LAST item in the list.
bool	Cpl_Container_SList_putFirst (CplContainerSList_T *list, void *item)
	Adds the item as the FIRST item in the list.
void *	Cpl_Container_SList_peekHead (const CplContainerSList_T *list)
	Returns a pointer to the FIRST item in the list.
void *	Cpl_Container_SList_peekTail (const CplContainerSList_T *list)
	Return a pointer to the LAST item in the list.
bool	Cpl_Container_SList_remove (CplContainerSList_T *list, void *itemToRemove)
	This function searches the list and - if found - removes the specified item from the list.
void *	Cpl_Container_SList_next (const void *item)
	This function returns the next item in the list AFTER the specified item.
bool	Cpl_Container_SList_isInList (const CplContainerSList_T *list, const void *item)
	Returns 'true' if the instance is in the specified list.

---

Class Documentation

CplContainerSList_T

struct CplContainerSList_T

This structure define the internal structure of a Singly Linked List.

The application should treat this struct as black box, i.e. never access the field members directly.

Collaboration diagram for CplContainerSList_T:

Class Members
CplContainerItemSListLinkage_T *	headPtr	Pointer to the first item in the list.
CplContainerItemSListLinkage_T *	tailPtr	Pointer to the last item in the list.

Typedef Documentation

CplContainerSList_T

typedef struct CplContainerSList_T CplContainerSList_T

This structure define the internal structure of a Singly Linked List.

The application should treat this struct as black box, i.e. never access the field members directly.

Function Documentation

Cpl_Container_SList_clear()

void Cpl_Container_SList_clear

(

CplContainerSList_T *

listToClear

)

Empties the list.

All references to the item(s) in the list are lost.

Cpl_Container_SList_get()

void * Cpl_Container_SList_get

(

CplContainerSList_T *

list

)

Removes the FIRST item in the list.

Returns NULL if the list is empty.

Cpl_Container_SList_getLast()

void * Cpl_Container_SList_getLast

(

CplContainerSList_T *

list

)

Removes the LAST item in the list.

Returns NULL if the list is empty.

NOTE: This is 'expensive' operation in that the entire list will be traversed.

Cpl_Container_SList_initialize()

void Cpl_Container_SList_initialize

(

CplContainerSList_T *

listToInitialize

)

Initializes the list.

This method must be called before calling any other functions in this interface..

EXCEPTION: If the CplContainerSList_T instance is statically allocated, aka it is in the BSS segment, it does not have be initialized using this function since the C/C++ standard guaranties all data in the BSS segment will be initialized to zero on start-up (which is the initialized state).

Cpl_Container_SList_isInList()

bool Cpl_Container_SList_isInList	(	const CplContainerSList_T *	list,
		const void *	item
	)

Returns 'true' if the instance is in the specified list.

Cpl_Container_SList_move()

void Cpl_Container_SList_move	(	CplContainerSList_T *	dstList,
		CplContainerSList_T *	srcList
	)

Moves the content of 'srcList' to the 'dstList'.

The 'dstList' is cleared before the move operation occurs.

Cpl_Container_SList_next()

void * Cpl_Container_SList_next

(

const void *

item

)

This function returns the next item in the list AFTER the specified item.

The returned item is NOT removed from the list. This method is typically use to traverse the list without changing its list membership. If there is no next item the method returns 0. The method will also return 0 if the specified item is NOT in the list.

Cpl_Container_SList_peekHead()

void * Cpl_Container_SList_peekHead

(

const CplContainerSList_T *

list

)

Returns a pointer to the FIRST item in the list.

The returned item remains in the list. Returns 0 if the list is empty.

Cpl_Container_SList_peekTail()

void * Cpl_Container_SList_peekTail

(

const CplContainerSList_T *

list

)

Return a pointer to the LAST item in the list.

The returned item remains in the list. Returns 0 if the list is empty.

Cpl_Container_SList_put()

bool Cpl_Container_SList_put	(	CplContainerSList_T *	list,
		void *	item
	)

Adds the item as the LAST item in the list.

Returns true if the operation was successful; else false is returned.

Cpl_Container_SList_putFirst()

bool Cpl_Container_SList_putFirst	(	CplContainerSList_T *	list,
		void *	item
	)

Adds the item as the FIRST item in the list.

Returns true if the operation was successful; else false is returned.

Cpl_Container_SList_remove()

bool Cpl_Container_SList_remove	(	CplContainerSList_T *	list,
		void *	itemToRemove
	)

This function searches the list and - if found - removes the specified item from the list.

Returns true of the item was found and removed form the list; else false is returned.