This graph shows which files directly or indirectly include this file:

Classes
struct	SJListElementData
	simple datatype abstracting the data held. More...

struct	SJList
	this is a simple list structure intended to hold an arbitrary number of elements list will automatically grow as space is needed to accomodate more elements More...

Functions
SJList *	sj_list_new ()
	create a new list More...

SJList *	sj_list_new_size (unsigned int count)
	allocate a new empty list of size 'count' More...

void	sj_list_delete (SJList *list)
	deletes a list that has been previously allocated More...

void *	sj_list_get_nth (SJList *list, unsigned int n)
	get the data stored at the nth element More...

void	sj_list_append (SJList list, void data)
	add an element to the end of the list More...

SJList *	sj_list_insert (SJList list, void data, unsigned int n)
	instert a new element at the position provided More...

SJList *	sj_list_delete_nth (SJList *list, unsigned int n)
	delete the element at the nth position in the list More...

int	sj_list_delete_data (SJList list, void data)
	delete the first element in the list pointing to the address of data More...

unsigned int	sj_list_get_count (SJList *list)
	get the number of tracked elements in the list More...

Function Documentation

void sj_list_append	(	SJList *	list,
		void *	data
	)

add an element to the end of the list

Parameters

list	the list to add to
data	the data to assign to the new element

Definition at line 83 of file simple_json_list.c.

void sj_list_delete ( SJList * list )

deletes a list that has been previously allocated

Parameters

list	the list to delete;

Definition at line 7 of file simple_json_list.c.

int sj_list_delete_data	(	SJList *	list,
		void *	data
	)

delete the first element in the list pointing to the address of data

Note: does not delete the data itself

Parameters

list	the list to delete the element from
data	used to match against which element to delete

Returns: 0 on complete, error otherwise

Definition at line 148 of file simple_json_list.c.

SJList* sj_list_delete_nth	(	SJList *	list,
		unsigned int	n
	)

delete the element at the nth position in the list

Parameters

list	the list to delete out of
n	the element to delete. This is no-op if the nth element is beyond the scope of the list (event is logged)

Returns: the list provided

Definition at line 170 of file simple_json_list.c.

unsigned int sj_list_get_count ( SJList * list )

get the number of tracked elements in the list

Parameters

list	the list the check

Returns: the count in the list. Will be zero if list was NULL

Definition at line 192 of file simple_json_list.c.

void* sj_list_get_nth	(	SJList *	list,
		unsigned int	n
	)

get the data stored at the nth element

Parameters

list	the list to pull data from
n	which element to look out

Returns: NULL on error (such as if n > the element count) or the address of the data otherwise

Definition at line 49 of file simple_json_list.c.

SJList* sj_list_insert	(	SJList *	list,
		void *	data,
		unsigned int	n
	)

instert a new element at the position provided

Parameters

list	the list to insert into
data	the data to assin to the new element

Returns: the address of the list. In the event that the list needed to expand this will be different from the list provided

Definition at line 109 of file simple_json_list.c.

SJList* sj_list_new ( )

create a new list

Returns: NULL on memory error or an initialized list

Definition at line 17 of file simple_json_list.c.

SJList* sj_list_new_size ( unsigned int count )

allocate a new empty list of size 'count'

Parameters

count how many elements you wish to support in this list.

Returns: NULL on memory error or a new empty list

Definition at line 22 of file simple_json_list.c.

Classes

Functions

Function Documentation