src/list.h File Reference

#include <sys/types.h>

Include dependency graph for list.h:

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

Defines
#define	list_for_each_safe(first, node, tmp)
	Iterate safely through the nodes in a list.
#define	list_for_each_reverse_safe(last, node, tmp)
	Reverse iterate safely through the nodes in a list.
#define	list_for_each(first, node) for ((node) = (first); (node) != (node)->next; (node) = (node)->next)
	Iterate through the nodes in a list.
#define	list_for_each_reverse(last, node) for ((node) = (last); (node) != (node)->prev; (node) = (node)->prev)
	Reverse iterate through the nodes in a list.
#define	list_entry(ptr, type, member) ((type )_list_entry((ptr), (size_t)&((type )0)->member))
	Gets the entry containing a list node.
#define	_list_entry(ptr, ln_offset) (void )((char )(ptr)-(ln_offset))
	Gets the entry containing a list node.
#define	list_new(pptr, type, member) _list_new((pptr), (size_t)&((type *)0)->member)
	Creates a new list.
Functions
int	_list_new (list_t **list, size_t ln_offset)
	Creates a new doubly linked list.
int	list_free (list_t *list)
	Frees a list.
struct list_node *	list_head (list_t *list)
	Gets the head node of a list.
struct list_node *	list_tail (list_t *list)
	Gets the tail node of a list.
int	list_insert_before (struct list_node p, struct list_node q)
	Inserts a node before another node in a list.
int	list_insert_after (struct list_node p, struct list_node q)
	Inserts a node after another node in a list.
int	list_insert_chain_after (struct list_node p, struct list_node start, struct list_node *end)
	Inserts a chain of nodes after another node in a list.
int	list_delete_chain (struct list_node start, struct list_node end)
	Deletes a chain of nodes from the list.

Detailed Description

List API.

Definition in file list.h.

Define Documentation

#define _list_entry	(	ptr,
		ln_offset		)	(void )((char )(ptr)-(ln_offset))

Gets the entry containing a list node.

Parameters:

	ptr	pointer to a struct list_node
	ln_offset	the offset in bytes in the entry the list node is stored at

Returns:: a (type *) pointer to the entry

Definition at line 112 of file list.h.

#define list_entry	(	ptr,
		type,
		member	)	((type )_list_entry((ptr), (size_t)&((type )0)->member))

Gets the entry containing a list node.

Parameters:

	ptr	pointer to a struct list_node
	type	the type of the entry containing the list node
	member	the member of the type storing the list node

Returns:: a (type *) pointer to the entry

Definition at line 101 of file list.h.

Referenced by action_list_clear(), actions_make_private_copy(), bless_buffer_free(), bless_buffer_redo(), bless_buffer_save(), bless_buffer_undo(), find_seg_entry(), free_edge_list(), free_vertex_list(), overlap_graph_get_removed_edges(), overlap_graph_get_vertices_topo(), and undo_list_enforce_limit().

#define list_for_each	(	first,
		node		)	for ((node) = (first); (node) != (node)->next; (node) = (node)->next)

Iterate through the nodes in a list.

If nodes are going to be altered or deleted during the iteration use list_for_each_safe().

Parameters:

	first	the list node to start from
	node	a struct list_node pointer that will hold the current node in each iteration

Definition at line 76 of file list.h.

Referenced by bless_buffer_save().

#define list_for_each_reverse	(	last,
		node		)	for ((node) = (last); (node) != (node)->prev; (node) = (node)->prev)

Reverse iterate through the nodes in a list.

If nodes are going to be altered or deleted during the iteration use list_for_each_reverse_safe().

Parameters:

	last	the list node to start from
	node	a struct list_node pointer that will hold the current node in each iteration

Definition at line 89 of file list.h.

#define list_for_each_reverse_safe	(	last,
		node,
		tmp	)

Value:

for ((node) = (last), (tmp) = (node)->prev; (node) != (node)->prev; \
            (node) = (tmp), (tmp) = (tmp)->prev)

Reverse iterate safely through the nodes in a list.

This macro should be used when nodes are going to be altered or deleted during the iteration.

Parameters:

	last	the list node to start from
	node	a struct list_node pointer that will hold the current node in each iteration
	tmp	a struct list_node pointer that will be used internally for safe iteration

Definition at line 62 of file list.h.

Referenced by actions_make_private_copy().

#define list_for_each_safe	(	first,
		node,
		tmp	)

Value:

for ((node) = (first), (tmp) = (node)->next; (node) != (node)->next; \
            (node) = (tmp), (tmp) = (tmp)->next)

Iterate safely through the nodes in a list.

This macro should be used when nodes are going to be altered or deleted during the iteration.

Parameters:

	first	the list node to start from
	node	a struct list_node pointer that will hold the current node in each iteration
	tmp	a struct list_node pointer that will be used internally for safe iteration