4 * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 2001 Bernardo Innocenti <bernie@develer.com>
6 * This file is part of DevLib - See devlib/README for information.
11 * \author Bernardo Innocenti <bernie@develer.com>
13 * \brief General pourpose double-linked lists
18 *#* Revision 1.11 2004/12/31 16:44:11 bernie
19 *#* list_remHead(), list_remTail(): Name like normal functions.
21 *#* Revision 1.10 2004/11/28 23:21:05 bernie
22 *#* Remove obsolete INITLIST macro.
24 *#* Revision 1.9 2004/10/21 09:37:55 bernie
25 *#* Revamp documentation.
27 *#* Revision 1.8 2004/10/19 08:46:34 bernie
30 *#* Revision 1.7 2004/08/25 14:12:09 rasky
31 *#* Aggiornato il comment block dei log RCS
33 *#* Revision 1.6 2004/07/30 14:34:10 rasky
34 *#* Vari fix per documentazione e commenti
35 *#* Aggiunte PP_CATn e STATIC_ASSERT
37 *#* Revision 1.5 2004/07/20 23:45:01 bernie
38 *#* Finally remove redundant protos.
40 *#* Revision 1.4 2004/07/18 22:12:53 bernie
41 *#* Fix warnings with GCC 3.3.2.
43 *#* Revision 1.3 2004/07/18 22:01:43 bernie
44 *#* REMHEAD(), REMTAIL(): Move to list.h as inline functions.
46 *#* Revision 1.2 2004/06/03 11:27:09 bernie
47 *#* Add dual-license information.
49 *#* Revision 1.1 2004/05/23 15:43:16 bernie
50 *#* Import mware modules.
56 #include <compiler.h> // INLINE
59 * This structure represents a node for bidirectional lists.
61 * Data is usually appended to nodes by making them the first
62 * field of another struture, as a poor-man's form of inheritance.
71 * Head of a doubly-linked list of \c Node structs.
73 * Lists must be initialized with LIST_INIT() prior to use.
75 * Nodes can be added and removed from either end of the list
76 * with O(1) performance. Iterating over these lists can be
77 * tricky: use the FOREACHNODE() macro instead.
87 /*! Template for a list of \a T structures. */
88 #define DECLARE_LIST(T) \
89 struct { T *head; T *null; T *tail; }
91 /*! Template for a node in a list of \a T structures. */
92 #define DECLARE_NODE(T) \
93 struct { T *succ; T *pred; }
95 /*! Template for a node in a list of \a T structures. */
96 #define DECLARE_NODE_ANON(T) \
100 * Iterate over all nodes in a list.
102 * This macro generates a "for" statement using the following parameters:
103 * \param n Node pointer to be used in each iteration.
104 * \param l Pointer to list.
106 #define FOREACHNODE(n,l) \
108 (n) = (typeof(n))((l)->head); \
109 ((Node *)(n))->succ; \
110 (n) = (typeof(n))(((Node *)(n))->succ) \
113 /*! Initialize a list. */
114 #define LIST_INIT(l) \
116 (l)->head = (Node *)(&(l)->null); \
118 (l)->tail = (Node *)(&(l)->head); \
121 /*! Add node to list head. */
122 #define ADDHEAD(l,n) \
124 (n)->succ = (l)->head; \
125 (n)->pred = (Node *)&(l)->head; \
126 (n)->succ->pred = (n); \
130 /*! Add node to list tail. */
131 #define ADDTAIL(l,n) \
133 (n)->succ = (Node *)(&(l)->null); \
134 (n)->pred = (l)->tail; \
135 (n)->pred->succ = (n); \
140 * Insert node \a n before node \a ln.
142 * \note You can't pass in a list header as \a ln, but
143 * it is safe to pass list-\>head of an empty list.
145 #define INSERTBEFORE(n,ln) \
148 (n)->pred = (ln)->pred; \
149 (ln)->pred->succ = (n); \
154 * Remove \a n from whatever list it is in.
156 * \note Removing a node that has not previously been
157 * inserted into a list invokes undefined behavior.
161 (n)->pred->succ = (n)->succ; \
162 (n)->succ->pred = (n)->pred; \
165 /*! Tell whether a list is empty. */
166 #define ISLISTEMPTY(l) ( (l)->head == (Node *)(&(l)->null) )
169 * Unlink a node from the head of the list \a l.
171 * \return Pointer to node, or NULL if the list was empty.
173 INLINE Node *list_remHead(List *l)
182 n->succ->pred = (Node *)l;
187 * Unlink a node from the tail of the list \a l.
189 * \return Pointer to node, or NULL if the list was empty.
191 INLINE Node *list_remTail(List *l)
200 n->pred->succ = (Node *)&l->null;
205 #define REMHEAD list_remHead
206 #define REMTAIL list_remTail
208 #endif /* MWARE_LIST_H */