5204f35eaf7eb5f8bfb780a5ab272a416d429eed
[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 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 1.1  1997/10/10 14:46:43  crh
31  * This is the ubiqx binary tree and linked list library.
32  * This library is being included as part of the Samba distribution.
33  * (Hurray!)
34  *
35  * Revision 0.1  1997/10/07 04:34:38  crh
36  * Initial Revision.
37  *
38  *
39  * ========================================================================== **
40  */
41
42 #include <stdlib.h>
43
44
45 /* ========================================================================== **
46  * Typedefs...
47  *
48  *  ubi_dlNode    - This is the basic node structure.
49  *  ubi_dlNodePtr - Pointer to a node.
50  *  ubi_dlList    - This is the list header structure.
51  *  ubi_dlListPtr - Pointer to a List (i.e., a list header structure).
52  *
53  */
54
55 typedef struct ubi_dlListNode
56   {
57   struct ubi_dlListNode *Next;
58   struct ubi_dlListNode *Prev;
59   } ubi_dlNode;
60
61 typedef ubi_dlNode *ubi_dlNodePtr;
62
63 typedef struct
64   {
65   ubi_dlNodePtr Head;
66   ubi_dlNodePtr Tail;
67   unsigned long count;
68   } ubi_dlList;
69
70 typedef ubi_dlList *ubi_dlListPtr;
71
72 /* ========================================================================== **
73  * Macros...
74  * 
75  *  ubi_dlAddHead - Add a new node at the head of the list.
76  *  ubi_dlAddTail - Add a new node at the tail of the list.
77  *  ubi_dlRemHead - Remove the node at the head of the list, if any.
78  *  ubi_dlRemTail - Remove the node at the tail of the list, if any.
79  *  ubi_dlFirst   - Return a pointer to the first node in the list, if any.
80  *  ubi_dlLast    - Return a pointer to the last node in the list, if any.
81  *  ubi_dlNext    - Given a node, return a pointer to the next node.
82  *  ubi_dlPrev    - Given a node, return a pointer to the previous node.
83  */
84
85 #define ubi_dlAddHead( L, N ) ubi_dlInsert( (L), (N), NULL )
86
87 #define ubi_dlAddTail( L, N ) ubi_dlInsert( (L), (N), ((L)->Tail) )
88
89 #define ubi_dlRemHead( L ) ubi_dlRemove( (L), ((L)->Head) )
90
91 #define ubi_dlRemTail( L ) ubi_dlRemove( (L), ((L)->Tail) )
92
93 #define ubi_dlFirst( L ) ((L)->Head)
94
95 #define ubi_dlLast( L )  ((L)->Tail)
96
97 #define ubi_dlNext( N )  ((N)->Next)
98
99 #define ubi_dlPrev( N )  ((N)->Prev)
100
101
102 /* ========================================================================== **
103  * Function prototypes...
104  */
105
106 ubi_dlListPtr ubi_dlInitList( ubi_dlListPtr ListPtr );
107   /* ------------------------------------------------------------------------ **
108    * Initialize a doubly-linked list header.
109    *
110    *  Input:  ListPtr - A pointer to the list structure that is to be
111    *                    initialized for use.
112    *
113    *  Output: A pointer to the initialized list header (i.e., same as
114    *          <ListPtr>).
115    *
116    * ------------------------------------------------------------------------ **
117    */
118
119 ubi_dlNodePtr ubi_dlInsert( ubi_dlListPtr ListPtr,
120                             ubi_dlNodePtr New,
121                             ubi_dlNodePtr After );
122   /* ------------------------------------------------------------------------ **
123    * Insert a new node into the list.
124    *
125    *  Input:  ListPtr - A pointer to the list into which the node is to
126    *                    be inserted.
127    *          New     - Pointer to the new node.
128    *          After   - NULL, or a pointer to a node that is already in the
129    *                    list.
130    *                    If NULL, then <New> will be added at the head of the
131    *                    list, else it will be added following <After>.
132    * 
133    *  Output: A pointer to the node that was inserted into the list (i.e.,
134    *          the same as <New>).
135    *
136    * ------------------------------------------------------------------------ **
137    */
138
139 ubi_dlNodePtr ubi_dlRemove( ubi_dlListPtr ListPtr, ubi_dlNodePtr Old );
140   /* ------------------------------------------------------------------------ **
141    * Remove a node from the list.
142    *
143    *  Input:  ListPtr - A pointer to the list from which <Old> is to be
144    *                    removed.
145    *          Old     - A pointer to the node that is to be removed from the
146    *                    list.
147    *
148    *  Output: A pointer to the node that was removed (i.e., <Old>).
149    *
150    * ------------------------------------------------------------------------ **
151    */
152
153
154 /* ================================ The End ================================= */
155 #endif /* ubi_dLinkList_H */