9e2cb9c4d2610f0efd9ee099ffbd6e58916f461e
[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.9  1998/06/04 21:29:27  crh
31  * Upper-cased defined constants (eg UBI_BINTREE_H) in some header files.
32  * This is more "standard", and is what people expect.  Weird, eh?
33  *
34  * Revision 0.8  1998/06/03 18:06:03  crh
35  * Further fiddling with sys_include.h, which has been moved from the .c file
36  * to the .h file.
37  *
38  * Revision 0.7  1998/06/02 01:38:47  crh
39  * Changed include file name from ubi_null.h to sys_include.h to make it
40  * more generic.
41  *
42  * Revision 0.6  1998/05/20 04:38:05  crh
43  * The C file now includes ubi_null.h.  See ubi_null.h for more info.
44  *
45  * Revision 0.5  1998/03/10 02:54:04  crh
46  * Simplified the code and added macros for stack & queue manipulations.
47  *
48  * Revision 0.4  1998/01/03 01:53:44  crh
49  * Added ubi_dlCount() macro.
50  *
51  * Revision 0.3  1997/10/15 03:04:31  crh
52  * Added some handy type casting to the macros.  Added AddHere and RemThis
53  * macros.
54  *
55  * Revision 0.2  1997/10/08 03:08:16  crh
56  * Fixed a few forgotten link-ups in Insert(), and fixed the AddHead()
57  * macro, which was passing the wrong value for <After> to Insert().
58  *
59  * Revision 0.1  1997/10/07 04:34:38  crh
60  * Initial Revision.
61  *
62  * -------------------------------------------------------------------------- **
63  * This module is similar to the ubi_sLinkList module, but it is neither a
64  * descendant type nor an easy drop-in replacement for the latter.  One key
65  * difference is that the ubi_dlRemove() function removes the indicated node,
66  * while the ubi_slRemove() function (in ubi_sLinkList) removes the node
67  * *following* the indicated node.
68  *
69  * ========================================================================== **
70  */
71
72 #include "sys_include.h"    /* System-specific includes. */
73
74 /* ========================================================================== **
75  * Typedefs...
76  *
77  *  ubi_dlNode    - This is the basic node structure.
78  *  ubi_dlNodePtr - Pointer to a node.
79  *  ubi_dlList    - This is the list header structure.
80  *  ubi_dlListPtr - Pointer to a List (i.e., a list header structure).
81  *
82  */
83
84 typedef struct ubi_dlListNode
85   {
86   struct ubi_dlListNode *Next;
87   struct ubi_dlListNode *Prev;
88   } ubi_dlNode;
89
90 typedef ubi_dlNode *ubi_dlNodePtr;
91
92 typedef struct
93   {
94   ubi_dlNodePtr Head;
95   ubi_dlNodePtr Tail;
96   unsigned long count;
97   } ubi_dlList;
98
99 typedef ubi_dlList *ubi_dlListPtr;
100
101 /* ========================================================================== **
102  * Macros...
103  *
104  *  ubi_dlCount   - Return the number of entries currently in the list.
105  *
106  *  ubi_dlAddHead - Add a new node at the head of the list.
107  *  ubi_dlAddNext - Add a node following the given node.
108  *  ubi_dlAddTail - Add a new node at the tail of the list.
109  *                  Note: AddTail evaluates the L parameter twice.
110  *
111  *  ubi_dlRemHead - Remove the node at the head of the list, if any.
112  *                  Note: RemHead evaluates the L parameter twice.
113  *  ubi_dlRemThis - Remove the indicated node.
114  *  ubi_dlRemTail - Remove the node at the tail of the list, if any.
115  *                  Note: RemTail evaluates the L parameter twice.
116  *
117  *  ubi_dlFirst   - Return a pointer to the first node in the list, if any.
118  *  ubi_dlLast    - Return a pointer to the last node in the list, if any.
119  *  ubi_dlNext    - Given a node, return a pointer to the next node.
120  *  ubi_dlPrev    - Given a node, return a pointer to the previous node.
121  *
122  *  ubi_dlPush    - Add a node at the head of the list (synonym of AddHead).
123  *  ubi_dlPop     - Remove a node at the head of the list (synonym of RemHead).
124  *  ubi_dlEnqueue - Add a node at the tail of the list (sysnonym of AddTail).
125  *  ubi_dlDequeue - Remove a node at the head of the list (synonym of RemHead).
126  *
127  *  Note that all of these provide type casting of the parameters.  The
128  *  Add and Rem macros are nothing more than nice front-ends to the
129  *  Insert and Remove operations.
130  *
131  *  Also note that there the First, Next and Last macros do no parameter
132  *  checking!
133  *
134  */
135
136 #define ubi_dlCount( L ) (((ubi_dlListPtr)(L))->count)
137
138 #define ubi_dlAddHead( L, N ) \
139         ubi_dlInsert( (ubi_dlListPtr)(L), (ubi_dlNodePtr)(N), NULL )
140
141 #define ubi_dlAddNext( L, N, A ) \
142         ubi_dlInsert( (ubi_dlListPtr)(L), \
143                       (ubi_dlNodePtr)(N), \
144                       (ubi_dlNodePtr)(A) )
145
146 #define ubi_dlAddTail( L, N ) \
147         ubi_dlInsert( (ubi_dlListPtr)(L), \
148                       (ubi_dlNodePtr)(N), \
149                     (((ubi_dlListPtr)(L))->Tail) )
150
151 #define ubi_dlRemHead( L ) ubi_dlRemove( (ubi_dlListPtr)(L), \
152                                          (((ubi_dlListPtr)(L))->Head) )
153
154 #define ubi_dlRemThis( L, N ) ubi_dlRemove( (ubi_dlListPtr)(L), \
155                                             (ubi_dlNodePtr)(N) )
156
157 #define ubi_dlRemTail( L ) ubi_dlRemove( (ubi_dlListPtr)(L), \
158                                          (((ubi_dlListPtr)(L))->Tail) )
159
160 #define ubi_dlFirst( L ) (((ubi_dlListPtr)(L))->Head)
161
162 #define ubi_dlLast( L )  (((ubi_dlListPtr)(L))->Tail)
163
164 #define ubi_dlNext( N )  (((ubi_dlNodePtr)(N))->Next)
165
166 #define ubi_dlPrev( N )  (((ubi_dlNodePtr)(N))->Prev)
167
168 #define ubi_dlPush    ubi_dlAddHead
169 #define ubi_dlPop     ubi_dlRemHead
170 #define ubi_dlEnqueue ubi_dlAddTail
171 #define ubi_dlDequeue ubi_dlRemHead
172
173 /* ========================================================================== **
174  * Function prototypes...
175  */
176
177 ubi_dlListPtr ubi_dlInitList( ubi_dlListPtr ListPtr );
178   /* ------------------------------------------------------------------------ **
179    * Initialize a doubly-linked list header.
180    *
181    *  Input:  ListPtr - A pointer to the list structure that is to be
182    *                    initialized for use.
183    *
184    *  Output: A pointer to the initialized list header (i.e., same as
185    *          <ListPtr>).
186    *
187    * ------------------------------------------------------------------------ **
188    */
189
190 ubi_dlNodePtr ubi_dlInsert( ubi_dlListPtr ListPtr,
191                             ubi_dlNodePtr New,
192                             ubi_dlNodePtr After );
193   /* ------------------------------------------------------------------------ **
194    * Insert a new node into the list.
195    *
196    *  Input:  ListPtr - A pointer to the list into which the node is to
197    *                    be inserted.
198    *          New     - Pointer to the new node.
199    *          After   - NULL, or a pointer to a node that is already in the
200    *                    list.
201    *                    If NULL, then <New> will be added at the head of the
202    *                    list, else it will be added following <After>.
203    * 
204    *  Output: A pointer to the node that was inserted into the list (i.e.,
205    *          the same as <New>).
206    *
207    * ------------------------------------------------------------------------ **
208    */
209
210 ubi_dlNodePtr ubi_dlRemove( ubi_dlListPtr ListPtr, ubi_dlNodePtr Old );
211   /* ------------------------------------------------------------------------ **
212    * Remove a node from the list.
213    *
214    *  Input:  ListPtr - A pointer to the list from which <Old> is to be
215    *                    removed.
216    *          Old     - A pointer to the node that is to be removed from the
217    *                    list.
218    *
219    *  Output: A pointer to the node that was removed (i.e., <Old>).
220    *
221    * ------------------------------------------------------------------------ **
222    */
223
224 /* ================================ The End ================================= */
225 #endif /* UBI_DLINKLIST_H */