Direct access to fifo elements

Detailed Description

Macros
#define	xbt_fifo_foreach(f, i, n, type)
	List iterator asserts and stuff. More...

Functions
xbt_fifo_item_t	xbt_fifo_new_item (void)
	Constructor. More...
void	xbt_fifo_set_item_content (xbt_fifo_item_t i, void *v)
void *	xbt_fifo_get_item_content (xbt_fifo_item_t i)
void	xbt_fifo_free_item (xbt_fifo_item_t i)
	Destructor. More...
void	xbt_fifo_push_item (xbt_fifo_t l, xbt_fifo_item_t i)
	Push a bucket. More...
xbt_fifo_item_t	xbt_fifo_pop_item (xbt_fifo_t i)
	Pop bucket. More...
void	xbt_fifo_unshift_item (xbt_fifo_t l, xbt_fifo_item_t i)
	Push a bucket. More...
xbt_fifo_item_t	xbt_fifo_shift_item (xbt_fifo_t l)
	Shift bucket. More...
int	xbt_fifo_remove (xbt_fifo_t l, void *t)
int	xbt_fifo_remove_all (xbt_fifo_t l, void *t)
void	xbt_fifo_remove_item (xbt_fifo_t l, xbt_fifo_item_t i)
xbt_fifo_item_t	xbt_fifo_get_first_item (xbt_fifo_t l)
xbt_fifo_item_t	xbt_fifo_get_last_item (xbt_fifo_t l)
xbt_fifo_item_t	xbt_fifo_get_next_item (xbt_fifo_item_t i)
xbt_fifo_item_t	xbt_fifo_get_prev_item (xbt_fifo_item_t i)

Macro Definition Documentation

xbt_fifo_foreach

#define xbt_fifo_foreach	(		f,
			i,
			n,
			type
	)

List iterator asserts and stuff.

Parameters

f	a list (xbt_fifo_t)
i	a bucket (xbt_fifo_item_t)
n	an object of type type.
type	the type of objects contained in the fifo

Iterates over the whole list.

Function Documentation

xbt_fifo_new_item()

xbt_fifo_item_t xbt_fifo_new_item ( void  )

inline

Constructor.

Returns

a new bucket

xbt_fifo_set_item_content()

void xbt_fifo_set_item_content ( xbt_fifo_item_t  i, void *  v  )

inline

Parameters

i	a bucket
v	an object

stores v in i.

xbt_fifo_get_item_content()

void* xbt_fifo_get_item_content ( xbt_fifo_item_t  i )

inline

Parameters

i

a bucket

Returns

the object stored i.

xbt_fifo_free_item()

void xbt_fifo_free_item ( xbt_fifo_item_t  b )

inline

Destructor.

Parameters

b	poor victim

Free the bucket but does not modifies the object (if any) that was stored in it.

xbt_fifo_push_item()

void xbt_fifo_push_item	(	xbt_fifo_t	l,
		xbt_fifo_item_t	new
	)

Push a bucket.

Parameters

l	list
new	bucket

Hook up this bucket at the tail of the list

xbt_fifo_pop_item()

xbt_fifo_item_t xbt_fifo_pop_item

(

xbt_fifo_t

l

)

Pop bucket.

Parameters

l

Returns

the bucket that was at the tail of the list.

Returns NULL if the list was empty.

xbt_fifo_unshift_item()

void xbt_fifo_unshift_item	(	xbt_fifo_t	l,
		xbt_fifo_item_t	new
	)

Push a bucket.

Parameters

l	list
new	bucket

Hook up this bucket at the head of the list

xbt_fifo_shift_item()

xbt_fifo_item_t xbt_fifo_shift_item

(

xbt_fifo_t

l

)

Shift bucket.

Parameters

l

Returns

the bucket that was at the head of the list.

Returns NULL if the list was empty.

xbt_fifo_remove()

int xbt_fifo_remove	(	xbt_fifo_t	l,
		void *	t
	)

Parameters

l
t	an objet

removes the first occurrence of t from l.

Warning

it will not remove duplicates

Returns

1 if an item was removed and 0 otherwise.

xbt_fifo_remove_all()

int xbt_fifo_remove_all	(	xbt_fifo_t	l,
		void *	t
	)

Parameters

l
t	an objet

removes all occurrences of t from l.

Returns

1 if an item was removed and 0 otherwise.

xbt_fifo_remove_item()

void xbt_fifo_remove_item	(	xbt_fifo_t	l,
		xbt_fifo_item_t	current
	)

Parameters

l	a list
current	a bucket

removes a bucket current from the list l. This function implicitly assumes (and doesn't check!) that this item belongs to this list...

xbt_fifo_get_first_item()

xbt_fifo_item_t xbt_fifo_get_first_item ( xbt_fifo_t  l )

inline

Parameters

l

a list

Returns

the head of l.

Returns NULL if the list is empty.

xbt_fifo_get_last_item()

xbt_fifo_item_t xbt_fifo_get_last_item ( xbt_fifo_t  l )

inline

Parameters

l

a list

Returns

the tail of l.

Returns NULL if the list is empty.

xbt_fifo_get_next_item()

xbt_fifo_item_t xbt_fifo_get_next_item ( xbt_fifo_item_t  i )

inline

Parameters

i

a bucket

Returns

the bucket that comes next

Returns NULL if i is the tail of the list.

xbt_fifo_get_prev_item()

xbt_fifo_item_t xbt_fifo_get_prev_item ( xbt_fifo_item_t  i )

inline

Parameters

i

a bucket

Returns

the bucket that is just before i.

Returns NULL if i is the head of the list.