sclist.c File Reference

Basic single chained generic list. More...

#include "sclist.h"
#include <stdlib.h>
#include <stdio.h>
#include <assert.h>

Include dependency graph for sclist.c:

Go to the source code of this file.

Classes
struct	sclistrecord_s
	Private list record structure. More...
struct	sclist_s
	Opaque sclist structure. More...

Typedefs
typedef struct sclistrecord_s	sclistrecord_t
	Private list record structure. More...
typedef struct sclist_s	sclist_t
	Opaque sclist structure. More...

Functions
sclist_t *	sclist_new ()
	Allocate and initialize the internal list structure. More...
void	sclist_del (sclist_t *sclist)
	Free all the list structure but not the values. More...
sclistrecord_t *	sclist_addrecord (sclist_t *sclist, void *value)
	Add a value at the end of the list. More...
void	sclist_remrecord (sclist_t *sclist, sclistrecord_t *record)
	Remove a record in a list. More...
sclistrecord_t *	sclist_firstrecord (const sclist_t *sclist)
	Returns the pointer on the first list record. More...
sclistrecord_t *	sclist_nextrecord (const sclistrecord_t *record)
	Returns the pointer on the record following the specified one. More...
void *	sclist_getvalue (sclistrecord_t *record)
	Returns the value pointer stored in the record. More...

Detailed Description

Basic single chained generic list.

Author

François Cerbelle (Fanfan), franc.nosp@m.ois@.nosp@m.cerbe.nosp@m.lle..nosp@m.net

Definition in file sclist.c.

Typedef Documentation

sclist_t

typedef struct sclist_s sclist_t

Opaque sclist structure.

sclistrecord_t

typedef struct sclistrecord_s sclistrecord_t

Private list record structure.

Function Documentation

sclist_addrecord()

sclistrecord_t * sclist_addrecord	(	sclist_t *	sclist,
		void *	value
	)

Add a value at the end of the list.

Parameters

sclist	The list structure to add the value to (NULL not supported)
value	A pointer on the value to add.

Returns

A pointer on the list record

Fails and abort the program execution in case of out of memory.

Definition at line 62 of file sclist.c.

sclist_del()

void sclist_del

(

sclist_t *

sclist

)

Free all the list structure but not the values.

Parameters

sclist

List structure (NULL not supported)

Free all the list structures, but DO NOT free the referenced values.

Definition at line 51 of file sclist.c.

sclist_firstrecord()

sclistrecord_t * sclist_firstrecord

(

const sclist_t *

sclist

)

Returns the pointer on the first list record.

Parameters

sclist

List structure (NULL not supported)

Returns

The pointer on the first record in the list

Return values

NULL	The list is empty
!NULL	The pointer on the value record

Definition at line 115 of file sclist.c.

sclist_getvalue()

void * sclist_getvalue

(

sclistrecord_t *

record

)

Returns the value pointer stored in the record.

Parameters

record

Pointer on the record to get the value from (NULL not supported)

Returns

Pointer on the value

Definition at line 127 of file sclist.c.

sclist_new()

sclist_t * sclist_new

(

)

Allocate and initialize the internal list structure.

Returns

Initialized list

Fails and abort the program execution in case of out of memory.

Definition at line 39 of file sclist.c.

sclist_nextrecord()

sclistrecord_t * sclist_nextrecord

(

const sclistrecord_t *

record

)

Returns the pointer on the record following the specified one.

Parameters

record

Pointer on the current record (NULL not supported)

Returns

The pointer on the next record if it exists

Return values

NULL	No next value found (end of list)
!NULL	The pointer on the value record

Definition at line 121 of file sclist.c.

sclist_remrecord()

void sclist_remrecord	(	sclist_t *	sclist,
		sclistrecord_t *	record
	)

Remove a record in a list.

Parameters

sclist	The list to remove the value from (NULL not supported)
record	A pointer on the record to remove (NULL not supported)

Fails and abort the program execution if the record is not found

Definition at line 90 of file sclist.c.