circular doubly linked list

Collaboration diagram for circular doubly linked list:

Data Structures
struct	a_list
	instance structure for circular doubly linked list More...

Macros
#define	A_LIST_INIT(node)
#define	a_list_(_, x)
	cast a list pointer from another type pointer
#define	a_list_entry(ptr, type, member)
	access the struct for this entry
#define	a_list_entry_next(ptr, type, member)
#define	a_list_entry_prev(ptr, type, member)
#define	a_list_foreach_(it, ctx, next)
	iterate over a list
#define	a_list_foreach_next(it, ctx)
#define	a_list_foreach_prev(it, ctx)
#define	a_list_forsafe_(it, at, ctx, next)
	iterate over a list safe against removal of list entry
#define	a_list_forsafe_next(it, at, ctx)
#define	a_list_forsafe_prev(it, at, ctx)

Typedefs
typedef struct a_list	a_list
	instance structure for circular doubly linked list

Functions
void	a_list_ctor (a_list *ctx)
	constructor for circular doubly linked list
void	a_list_init (a_list *ctx)
	initialize for circular doubly linked list
void	a_list_dtor (a_list *ctx)
	destructor for circular doubly linked list
void	a_list_link (a_list *head, a_list *tail)
	link head node and tail node
void	a_list_loop (a_list *head, a_list *tail)
	loop head node to tail node
void	a_list_add_ (a_list *head1, a_list *tail1, a_list *head2, a_list *tail2)
	connect list1 and list2
void	a_list_add_node (a_list *head, a_list *tail, a_list *node)
	insert a node to a list
void	a_list_add_next (a_list *ctx, a_list *node)
	append a node to a list forward
void	a_list_add_prev (a_list *ctx, a_list *node)
	append a node to a list backward
void	a_list_del_ (a_list const *head, a_list const *tail)
	delete a section of a list
void	a_list_del_node (a_list const *node)
	delete a node from a list
void	a_list_del_next (a_list const *node)
	remove a node from a list forward
void	a_list_del_prev (a_list const *node)
	remove a node from a list backward
void	a_list_set_ (a_list const *head1, a_list const *tail1, a_list *head2, a_list *tail2)
	modify a section of a list
void	a_list_set_node (a_list const *ctx, a_list *rhs)
	modify a node of a list
void	a_list_mov_next (a_list *ctx, a_list const *rhs)
	moving a list from another list forward
void	a_list_mov_prev (a_list *ctx, a_list const *rhs)
	moving a list from another list backward
void	a_list_rot_next (a_list *ctx)
	rotate a node in the list backward
void	a_list_rot_prev (a_list *ctx)
	rotate a node in the list forward
void	a_list_swap_ (a_list *head1, a_list *tail1, a_list *head2, a_list *tail2)
	swap a section of one list and a section of another list
void	a_list_swap_node (a_list *lhs, a_list *rhs)
	swap the node lhs and the node rhs

Detailed Description

Macro Definition Documentation

a_list_

#define a_list_	(		_,
			x )

Value:

a_cast_s(a_list _, a_cast_s(void _, x))

cast a list pointer from another type pointer

Parameters

[in]	_	additional attributes of specified type
[in]	x	points to circular doubly linked list

Returns

a pointer to circular doubly linked list

a_list_entry

#define a_list_entry	(		ptr,
			type,
			member )

Value:

a_container_of(ptr, type, member)

access the struct for this entry

Parameters

ptr	the &a_list pointer
type	the type of the struct this is embedded in
member	the name of the a_list within the struct

a_list_entry_next

#define a_list_entry_next	(		ptr,
			type,
			member )

Value:

a_list_entry((ptr)->next, type, member)

a_list_entry_prev

#define a_list_entry_prev	(		ptr,
			type,
			member )

Value:

a_list_entry((ptr)->prev, type, member)

a_list_foreach_

#define a_list_foreach_	(		it,
			ctx,
			next )

Value:

    for (a_list *it = (ctx)->next; it != (ctx); it = it->next)

iterate over a list

Parameters

it	the &a_list to use as a loop counter
ctx	points to circular doubly linked list
next	the direction of loop iteration next the backward iteration prev the forward iteration

a_list_foreach_next

#define a_list_foreach_next	(		it,
			ctx )

Value:

a_list_foreach_(it, ctx, next)

a_list_foreach_prev

#define a_list_foreach_prev	(		it,
			ctx )

Value:

a_list_foreach_(it, ctx, prev)

a_list_forsafe_

#define a_list_forsafe_	(		it,
			at,
			ctx,
			next )

Value:

    for (a_list *it = (ctx)->next, *at = it->next; it != (ctx); it = at, at = it->next)

iterate over a list safe against removal of list entry

Parameters

it	the &a_list to use as a loop counter
at	another &a_list to use as temporary storage
ctx	points to circular doubly linked list
next	the direction of loop iteration next the backward iteration prev the forward iteration

a_list_forsafe_next

#define a_list_forsafe_next	(		it,
			at,
			ctx )

Value:

a_list_forsafe_(it, at, ctx, next)

a_list_forsafe_prev

#define a_list_forsafe_prev	(		it,
			at,
			ctx )

Value:

a_list_forsafe_(it, at, ctx, prev)

A_LIST_INIT

#define A_LIST_INIT

(

node

)

Value:

{&(node), &(node)}

Function Documentation

a_list_add_()

void a_list_add_	(	a_list *	head1,
		a_list *	tail1,
		a_list *	head2,
		a_list *	tail2 )

connect list1 and list2

Parameters

[in,out]	head1	the head node of the list1
[in,out]	tail1	the tail node of the list1
[in,out]	head2	the head node of the list2
[in,out]	tail2	the tail node of the list2

a_list_add_next()

void a_list_add_next	(	a_list *	ctx,
		a_list *	node )

append a node to a list forward

Parameters

[in,out]	ctx	points to circular doubly linked list
[in]	node	a circular doubly linked list node

a_list_add_node()

void a_list_add_node	(	a_list *	head,
		a_list *	tail,
		a_list *	node )

insert a node to a list

Parameters

[in,out]	head	the head node of a list
[in,out]	tail	the tail node of a list
[in]	node	a circular doubly linked list node

a_list_add_prev()

void a_list_add_prev	(	a_list *	ctx,
		a_list *	node )

append a node to a list backward

Parameters

[in,out]	ctx	points to circular doubly linked list
[in]	node	a circular doubly linked list node

a_list_ctor()

void a_list_ctor

(

a_list *

ctx

)

constructor for circular doubly linked list

Parameters

[in,out]

ctx

points to circular doubly linked list

a_list_del_()

void a_list_del_	(	a_list const *	head,
		a_list const *	tail )

delete a section of a list

Parameters

[in]	head	the head node of a list
[in]	tail	the tail node of a list

a_list_del_next()

void a_list_del_next

(

a_list const *

node

)

remove a node from a list forward

Parameters

[in]

node

a circular doubly linked list node

a_list_del_node()

void a_list_del_node

(

a_list const *

node

)

delete a node from a list

Parameters

[in]

node

a circular doubly linked list node

a_list_del_prev()

void a_list_del_prev

(

a_list const *

node

)

remove a node from a list backward

Parameters

[in]

node

a circular doubly linked list node

a_list_dtor()

void a_list_dtor

(

a_list *

ctx

)

destructor for circular doubly linked list

Parameters

[in,out]

ctx

points to circular doubly linked list

a_list_init()

void a_list_init

(

a_list *

ctx

)

initialize for circular doubly linked list

Parameters

[in,out]

ctx

points to circular doubly linked list

a_list_link()

void a_list_link	(	a_list *	head,
		a_list *	tail )

link head node and tail node

Parameters

[in,out]	head	the head node of a list
[in,out]	tail	the tail node of a list

a_list_loop()

void a_list_loop	(	a_list *	head,
		a_list *	tail )

loop head node to tail node

Parameters

[in,out]	head	the head node of a list
[in,out]	tail	the tail node of a list

a_list_mov_next()

void a_list_mov_next	(	a_list *	ctx,
		a_list const *	rhs )

moving a list from another list forward

Parameters

[in,out]	ctx	points to circular doubly linked list
[in]	rhs	another circular doubly linked list

a_list_mov_prev()

void a_list_mov_prev	(	a_list *	ctx,
		a_list const *	rhs )

moving a list from another list backward

Parameters

[in,out]	ctx	points to circular doubly linked list
[in]	rhs	another circular doubly linked list

a_list_rot_next()

void a_list_rot_next

(

a_list *

ctx

)

rotate a node in the list backward

Parameters

[in,out]

ctx

points to circular doubly linked list

a_list_rot_prev()

void a_list_rot_prev

(

a_list *

ctx

)

rotate a node in the list forward

Parameters

[in,out]

ctx

points to circular doubly linked list

a_list_set_()

void a_list_set_	(	a_list const *	head1,
		a_list const *	tail1,
		a_list *	head2,
		a_list *	tail2 )

modify a section of a list

Parameters

[in]	head1	the head node of the list1
[in]	tail1	the tail node of the list1
[in,out]	head2	the head node of the list2
[in,out]	tail2	the tail node of the list2

a_list_set_node()

void a_list_set_node	(	a_list const *	ctx,
		a_list *	rhs )

modify a node of a list

Parameters

[in]	ctx	the current node
[in,out]	rhs	the new node

a_list_swap_()

void a_list_swap_	(	a_list *	head1,
		a_list *	tail1,
		a_list *	head2,
		a_list *	tail2 )

swap a section of one list and a section of another list

Parameters

[in,out]	head1	the head node of the list1
[in,out]	tail1	the tail node of the list1
[in,out]	head2	the head node of the list2
[in,out]	tail2	the tail node of the list2

a_list_swap_node()

void a_list_swap_node	(	a_list *	lhs,
		a_list *	rhs )

swap the node lhs and the node rhs

Parameters

[in,out]	lhs	the node on the left
[in,out]	rhs	the node on the right