LinkList module

Detailed Description

Introduction.

The LinkList module provides the functionality of a single-link list of items.

Data Structures
struct	LLSTItemDesc
struct	LLSTListDesc

Macros
#define	LLST_DECLARE(name, size, attributes)

Typedefs
typedef struct LLSTItemDesc	LLSTItemDesc
typedef struct LLSTItemDesc *	LLSTItem
typedef struct LLSTListDesc *	LLSTList

Functions
HALRESULT	LLST_Init (LLSTList list, LLSTItem items, size_t size)
HALRESULT	LLST_Deinit (LLSTList list)
HALRESULT	LLST_AddItem (LLSTList list, const void *data, LLSTItem *new_item)
const void *	LLST_UnlinkFirstItem (LLSTList list)
const void *	LLST_UnlinkLastItem (LLSTList list)
const void *	LLST_UnlinkItem (LLSTList list, LLSTItem item)
LLSTItem	LLST_GetFirstItem (LLSTList list)
LLSTItem	LLST_GetNextItem (LLSTItem item)
LLSTItem	LLST_GetLastItem (LLSTList list)
LLSTItem	LLST_GetItemByIndex (LLSTList list, size_t index)
LLSTItem	LLST_GetItemByData (LLSTList list, const void *data)
const void *	LLST_GetItemData (LLSTItem item)
HALRESULT	LLST_SetItemData (LLSTItem item, const void *data)

Macro Definition Documentation

#define LLST_DECLARE	(		name,
			size,
			attributes
	)

Value:

static LLSTItemDesc name##_items[size]; \
    attributes LLSTListDesc name = { size, name##_items , NULL, NULL}

Function Documentation

HALRESULT LLST_Init	(	LLSTList	list,
		LLSTItem	items,
		size_t	size
	)

Initializes link list.

Parameters

list	link list
items	pointer to a pool of items
size	number of elements in the pool of items

Return values

HALRESULT_OK	if list was initialized successfully
HALRESULT_EMPTY_LINKLIST	when the provided pool size is zero
HALRESULT_INVALID_LINKLIST	when the provided pool or list is invalid

References DIAG_DEFAULT_CHANNEL.

HALRESULT LLST_Deinit

(

LLSTList

list

)

Deinitializes link list.

Parameters

list

link list

Return values

HALRESULT_OK	if list was deinitialized successfully
HALRESULT_INVALID_LINKLIST	if provided link list is invalid

References DIAG_DEFAULT_CHANNEL.

HALRESULT LLST_AddItem	(	LLSTList	list,
		const void *	data,
		LLSTItem *	new_item
	)

Adds new item to the list.

Parameters

list	link list
data	item data
new_item	pointer to a variable where the new item will be stored

Return values

HALRESULT_OK	if new element was added successfully
HALRESULT_LINKLIST_FULL	if the list is full and new element cannot be added
HALRESULT_INVALID_LINKLIST_DATA	if the provided data is NULL
HALRESULT_INVALID_LINKLIST	if the list is invalid
HALRESULT_EMPTY_LINKLIST	if the list pool size is zero

References CORE_EnterCritical, CORE_ExitCritical, and DIAG_DEFAULT_CHANNEL.

const void* LLST_UnlinkFirstItem

(

LLSTList

list

)

Removes first item from the list.

Parameters

list

link list

Returns

data associated with the removed element

References CORE_EnterCritical, CORE_ExitCritical, and DIAG_DEFAULT_CHANNEL.

const void* LLST_UnlinkLastItem

(

LLSTList

list

)

Removes last item from the list.

Parameters

list

link list

Returns

data associated with the removed element

References LLST_UnlinkItem().

const void* LLST_UnlinkItem	(	LLSTList	list,
		LLSTItem	item
	)

Removes a given element from the list.

Parameters

list	link list
item

Returns

data associated with the removed element

References CORE_EnterCritical, CORE_ExitCritical, and DIAG_DEFAULT_CHANNEL.

Referenced by LLST_UnlinkLastItem().

LLSTItem LLST_GetFirstItem

(

LLSTList

list

)

Retrieves first element on the list.

Parameters

list

link list

Returns

first element on the list or NULL if the list holds no elements

References DIAG_DEFAULT_CHANNEL.

LLSTItem LLST_GetNextItem

(

LLSTItem

item

)

Retrieves next element on the list, relative to the given one.

Parameters

item	element on the list

Returns

next element on the list or NULL if the given element is last on the list

References DIAG_DEFAULT_CHANNEL.

LLSTItem LLST_GetLastItem

(

LLSTList

list

)

Retrieves last element on the list.

Parameters

list

link list

Returns

last element on the list or NULL if the list holds no elements

References DIAG_DEFAULT_CHANNEL.

LLSTItem LLST_GetItemByIndex	(	LLSTList	list,
		size_t	index
	)

Retrieves item under given index.

Parameters

list	link list
index	index (0-based)

Returns

item under given index or NULL if there is no element under given index

References DIAG_DEFAULT_CHANNEL.

LLSTItem LLST_GetItemByData	(	LLSTList	list,
		const void *	data
	)

Retrieves item associated with the given data.

Parameters

list	link list
data	item data

Returns

item associated with the given data or NULL if there is no such element

References DIAG_DEFAULT_CHANNEL.

const void* LLST_GetItemData

(

LLSTItem

item

)

Retrieves data associated with a given element.

Parameters

item

element

Returns

data associated with the given element

References DIAG_DEFAULT_CHANNEL.

HALRESULT LLST_SetItemData	(	LLSTItem	item,
		const void *	data
	)

Sets data for the given item.

Parameters

item	link list item
data	new data pointer

Return values

HALRESULT_OK	if the item data was set successfully
HALRESULT_INVALID_LINKLIST_ITEM	if item was invalid

References DIAG_DEFAULT_CHANNEL.