To each list type, I added a macro that makes it easier to define and
[samba.git] / source3 / ubiqx / ubi_dLinkList.h
1 #ifndef UBI_DLINKLIST_H
2 #define UBI_DLINKLIST_H
3 /* ========================================================================== **
4  *                              ubi_dLinkList.h
5  *
6  *  Copyright (C) 1997, 1998 by Christopher R. Hertel
7  *
8  *  Email: crh@ubiqx.mn.org
9  * -------------------------------------------------------------------------- **
10  *  This module implements simple doubly-linked lists.
11  * -------------------------------------------------------------------------- **
12  *
13  *  This library is free software; you can redistribute it and/or
14  *  modify it under the terms of the GNU Library General Public
15  *  License as published by the Free Software Foundation; either
16  *  version 2 of the License, or (at your option) any later version.
17  *
18  *  This library is distributed in the hope that it will be useful,
19  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21  *  Library General Public License for more details.
22  *
23  *  You should have received a copy of the GNU Library General Public
24  *  License along with this library; if not, write to the Free
25  *  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26  *
27  * -------------------------------------------------------------------------- **
28  *
29  * Log: ubi_dLinkList.h,v
30  * Revision 0.10  1998/07/24 07:30:20  crh
31  * Added the ubi_dlNewList() macro.
32  *
33  * Revision 0.9  1998/06/04 21:29:27  crh
34  * Upper-cased defined constants (eg UBI_BINTREE_H) in some header files.
35  * This is more "standard", and is what people expect.  Weird, eh?
36  *
37  * Revision 0.8  1998/06/03 18:06:03  crh
38  * Further fiddling with sys_include.h, which has been moved from the .c file
39  * to the .h file.
40  *
41  * Revision 0.7  1998/06/02 01:38:47  crh
42  * Changed include file name from ubi_null.h to sys_include.h to make it
43  * more generic.
44  *
45  * Revision 0.6  1998/05/20 04:38:05  crh
46  * The C file now includes ubi_null.h.  See ubi_null.h for more info.
47  *
48  * Revision 0.5  1998/03/10 02:54:04  crh
49  * Simplified the code and added macros for stack & queue manipulations.
50  *
51  * Revision 0.4  1998/01/03 01:53:44  crh
52  * Added ubi_dlCount() macro.
53  *
54  * Revision 0.3  1997/10/15 03:04:31  crh
55  * Added some handy type casting to the macros.  Added AddHere and RemThis
56  * macros.
57  *
58  * Revision 0.2  1997/10/08 03:08:16  crh
59  * Fixed a few forgotten link-ups in Insert(), and fixed the AddHead()
60  * macro, which was passing the wrong value for <After> to Insert().
61  *
62  * Revision 0.1  1997/10/07 04:34:38  crh
63  * Initial Revision.
64  *
65  * -------------------------------------------------------------------------- **
66  * This module is similar to the ubi_sLinkList module, but it is neither a
67  * descendant type nor an easy drop-in replacement for the latter.  One key
68  * difference is that the ubi_dlRemove() function removes the indicated node,
69  * while the ubi_slRemove() function (in ubi_sLinkList) removes the node
70  * *following* the indicated node.
71  *
72  * ========================================================================== **
73  */
74
75 #include "sys_include.h"    /* System-specific includes. */
76
77 /* ========================================================================== **
78  * Typedefs...
79  *
80  *  ubi_dlNode    - This is the basic node structure.
81  *  ubi_dlNodePtr - Pointer to a node.
82  *  ubi_dlList    - This is the list header structure.
83  *  ubi_dlListPtr - Pointer to a List (i.e., a list header structure).
84  *
85  */
86
87 typedef struct ubi_dlListNode
88   {
89   struct ubi_dlListNode *Next;
90   struct ubi_dlListNode *Prev;
91   } ubi_dlNode;
92
93 typedef ubi_dlNode *ubi_dlNodePtr;
94
95 typedef struct
96   {
97   ubi_dlNodePtr Head;
98   ubi_dlNodePtr Tail;
99   unsigned long count;
100   } ubi_dlList;
101
102 typedef ubi_dlList *ubi_dlListPtr;
103
104 /* ========================================================================== **
105  * Macros...
106  *
107  *  ubi_dlNewList - Macro used to declare and initialize a new list in one
108  *                  swell foop.  It is used when defining a variable of
109  *                  type ubi_dlList.  The definition
110  *                    static ubi_dlNewList( gerbil );
111  *                  is translated to
112  *                    static ubi_dlList gerbil[1] = {{ NULL, NULL, 0 }};
113  *
114  *  ubi_dlCount   - Return the number of entries currently in the list.
115  *
116  *  ubi_dlAddHead - Add a new node at the head of the list.
117  *  ubi_dlAddNext - Add a node following the given node.
118  *  ubi_dlAddTail - Add a new node at the tail of the list.
119  *                  Note: AddTail evaluates the L parameter twice.
120  *
121  *  ubi_dlRemHead - Remove the node at the head of the list, if any.
122  *                  Note: RemHead evaluates the L parameter twice.
123  *  ubi_dlRemThis - Remove the indicated node.
124  *  ubi_dlRemTail - Remove the node at the tail of the list, if any.
125  *                  Note: RemTail evaluates the L parameter twice.
126  *
127  *  ubi_dlFirst   - Return a pointer to the first node in the list, if any.
128  *  ubi_dlLast    - Return a pointer to the last node in the list, if any.
129  *  ubi_dlNext    - Given a node, return a pointer to the next node.
130  *  ubi_dlPrev    - Given a node, return a pointer to the previous node.
131  *
132  *  ubi_dlPush    - Add a node at the head of the list (synonym of AddHead).
133  *  ubi_dlPop     - Remove a node at the head of the list (synonym of RemHead).
134  *  ubi_dlEnqueue - Add a node at the tail of the list (sysnonym of AddTail).
135  *  ubi_dlDequeue - Remove a node at the head of the list (synonym of RemHead).
136  *
137  *  Note that all of these provide type casting of the parameters.  The
138  *  Add and Rem macros are nothing more than nice front-ends to the
139  *  Insert and Remove operations.
140  *
141  *  Also note that the First, Next and Last macros do no parameter checking!
142  *
143  */
144
145 #define ubi_dlNewList( L ) ubi_dlList (L)[1] = {{ NULL, NULL, 0 }}
146
147 #define ubi_dlCount( L ) (((ubi_dlListPtr)(L))->count)
148
149 #define ubi_dlAddHead( L, N ) \
150         ubi_dlInsert( (ubi_dlListPtr)(L), (ubi_dlNodePtr)(N), NULL )
151
152 #define ubi_dlAddNext( L, N, A ) \
153         ubi_dlInsert( (ubi_dlListPtr)(L), \
154                       (ubi_dlNodePtr)(N), \
155                       (ubi_dlNodePtr)(A) )
156
157 #define ubi_dlAddTail( L, N ) \
158         ubi_dlInsert( (ubi_dlListPtr)(L), \
159                       (ubi_dlNodePtr)(N), \
160                     (((ubi_dlListPtr)(L))->Tail) )
161
162 #define ubi_dlRemHead( L ) ubi_dlRemove( (ubi_dlListPtr)(L), \
163                                          (((ubi_dlListPtr)(L))->Head) )
164
165 #define ubi_dlRemThis( L, N ) ubi_dlRemove( (ubi_dlListPtr)(L), \
166                                             (ubi_dlNodePtr)(N) )
167
168 #define ubi_dlRemTail( L ) ubi_dlRemove( (ubi_dlListPtr)(L), \
169                                          (((ubi_dlListPtr)(L))->Tail) )
170
171 #define ubi_dlFirst( L ) (((ubi_dlListPtr)(L))->Head)
172
173 #define ubi_dlLast( L )  (((ubi_dlListPtr)(L))->Tail)
174
175 #define ubi_dlNext( N )  (((ubi_dlNodePtr)(N))->Next)
176
177 #define ubi_dlPrev( N )  (((ubi_dlNodePtr)(N))->Prev)
178
179 #define ubi_dlPush    ubi_dlAddHead
180 #define ubi_dlPop     ubi_dlRemHead
181 #define ubi_dlEnqueue ubi_dlAddTail
182 #define ubi_dlDequeue ubi_dlRemHead
183
184 /* ========================================================================== **
185  * Function prototypes...
186  */
187
188 ubi_dlListPtr ubi_dlInitList( ubi_dlListPtr ListPtr );
189   /* ------------------------------------------------------------------------ **
190    * Initialize a doubly-linked list header.
191    *
192    *  Input:  ListPtr - A pointer to the list structure that is to be
193    *                    initialized for use.
194    *
195    *  Output: A pointer to the initialized list header (i.e., same as
196    *          <ListPtr>).
197    *
198    * ------------------------------------------------------------------------ **
199    */
200
201 ubi_dlNodePtr ubi_dlInsert( ubi_dlListPtr ListPtr,
202                             ubi_dlNodePtr New,
203                             ubi_dlNodePtr After );
204   /* ------------------------------------------------------------------------ **
205    * Insert a new node into the list.
206    *
207    *  Input:  ListPtr - A pointer to the list into which the node is to
208    *                    be inserted.
209    *          New     - Pointer to the new node.
210    *          After   - NULL, or a pointer to a node that is already in the
211    *                    list.
212    *                    If NULL, then <New> will be added at the head of the
213    *                    list, else it will be added following <After>.
214    * 
215    *  Output: A pointer to the node that was inserted into the list (i.e.,
216    *          the same as <New>).
217    *
218    * ------------------------------------------------------------------------ **
219    */
220
221 ubi_dlNodePtr ubi_dlRemove( ubi_dlListPtr ListPtr, ubi_dlNodePtr Old );
222   /* ------------------------------------------------------------------------ **
223    * Remove a node from the list.
224    *
225    *  Input:  ListPtr - A pointer to the list from which <Old> is to be
226    *                    removed.
227    *          Old     - A pointer to the node that is to be removed from the
228    *                    list.
229    *
230    *  Output: A pointer to the node that was removed (i.e., <Old>).
231    *
232    * ------------------------------------------------------------------------ **
233    */
234
235 /* ================================ The End ================================= */
236 #endif /* UBI_DLINKLIST_H */