a281711b8170644376add0dfd2d9ef303f2b3aa0
[samba.git] / source3 / ubiqx / ubi_sLinkList.c
1 /* ========================================================================== **
2  *                              ubi_sLinkList.c
3  *
4  *  Copyright (C) 1997, 1998 by Christopher R. Hertel
5  *
6  *  Email: crh@ubiqx.mn.org
7  * -------------------------------------------------------------------------- **
8  *  This module implements a simple singly-linked list.
9  * -------------------------------------------------------------------------- **
10  *
11  *  This library is free software; you can redistribute it and/or
12  *  modify it under the terms of the GNU Library General Public
13  *  License as published by the Free Software Foundation; either
14  *  version 2 of the License, or (at your option) any later version.
15  *
16  *  This library is distributed in the hope that it will be useful,
17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  *  Library General Public License for more details.
20  *
21  *  You should have received a copy of the GNU Library General Public
22  *  License along with this library; if not, write to the Free
23  *  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  *
25  * -------------------------------------------------------------------------- **
26  *
27  * Log: ubi_sLinkList.c,v 
28  * Revision 0.8  1998/06/04 21:29:27  crh
29  * Upper-cased defined constants (eg UBI_BINTREE_H) in some header files.
30  * This is more "standard", and is what people expect.  Weird, eh?
31  *
32  * Revision 0.7  1998/06/03 18:06:03  crh
33  * Further fiddling with sys_include.h, which has been moved from the .c file
34  * to the .h file.
35  *
36  * Revision 0.6  1998/06/02 01:38:47  crh
37  * Changed include file name from ubi_null.h to sys_include.h to make it
38  * more generic.
39  *
40  * Revision 0.5  1998/05/20 04:38:05  crh
41  * The C file now includes ubi_null.h.  See ubi_null.h for more info.
42  *
43  * Revision 0.4  1998/03/10 02:23:20  crh
44  * Combined ubi_StackQueue and ubi_sLinkList into one module.  Redesigned
45  * the functions and macros.  Not a complete rewrite but close to it.
46  *
47  * Revision 0.3  1998/01/03 01:59:52  crh
48  * Added ubi_slCount() macro.
49  *
50  * Revision 0.2  1997/10/21 03:35:18  crh
51  * Added parameter <After> in function Insert().  Made necessary changes
52  * to macro AddHead() and added macro AddHere().
53  *
54  * Revision 0.1  1997/10/16 02:53:45  crh
55  * Initial Revision.
56  *
57  * -------------------------------------------------------------------------- **
58  *  This module implements a singly-linked list which may also be used as a
59  *  queue or a stack.  For a queue, entries are added at the tail and removed
60  *  from the head of the list.  For a stack, the entries are entered and
61  *  removed from the head of the list.  A traversal of the list will always
62  *  start at the head of the list and proceed toward the tail.  This is all
63  *  mind-numbingly simple, but I'm surprised by the number of programs out
64  *  there which re-implement this a dozen or so times.
65  *
66  *  Notes:  When the list header is initialized, the Tail pointer is set to
67  *          point to the Head pointer.  This simplifies things a great deal,
68  *          except that you can't initialize a stack or queue by simply
69  *          zeroing it out.  One sure way to initialize the header is to call
70  *          ubi_slInit().  Another option would be something like this:
71  *
72  *          static ubi_slList MyList = { NULL, (ubi_slNodePtr)&MyList, 0 };
73  *
74  *          See ubi_slInit() and the ubi_slList structure for more info.
75  *
76  *        + Also, note that this module is similar to the ubi_dLinkList
77  *          module.  There are three key differences:
78  *          - This is a singly-linked list, the other is a doubly-linked
79  *            list.
80  *          - In this module, if the list is empty, the tail pointer will
81  *            point back to the head of the list as described above.  This
82  *            is not done in ubi_dLinkList.
83  *          - The ubi_slRemove() function, by necessity, removed the 'next'
84  *            node.  In ubi_dLinkList, the ubi_dlRemove() function removes
85  *            the 'current' node.
86  *
87  * ========================================================================== **
88  */
89
90 #include "ubi_sLinkList.h"  /* Header for *this* module. */
91
92 /* ========================================================================== **
93  * Functions...
94  */
95
96 ubi_slListPtr ubi_slInitList( ubi_slListPtr ListPtr )
97   /* ------------------------------------------------------------------------ **
98    * Initialize a singly-linked list header.
99    *
100    *  Input:  ListPtr - A pointer to the list structure that is to be
101    *                    initialized for use.
102    *
103    *  Output: A pointer to the initialized list header (i.e., same as
104    *          <ListPtr>).
105    *
106    * ------------------------------------------------------------------------ **
107    */
108   {
109   ListPtr->Head  = NULL;
110   ListPtr->Tail  = (ubi_slNodePtr)ListPtr;
111   ListPtr->count = 0;
112   return( ListPtr );
113   } /* ubi_slInitList */
114
115 ubi_slNodePtr ubi_slInsert( ubi_slListPtr ListPtr,
116                             ubi_slNodePtr New,
117                             ubi_slNodePtr After )
118   /* ------------------------------------------------------------------------ **
119    * Add a node to the list.
120    *
121    *  Input:  ListPtr - A pointer to the list into which the node is to
122    *                    be inserted.
123    *          New     - Pointer to the node that is to be added to the list.
124    *          After   - Pointer to a list in a node after which the new node
125    *                    will be inserted.  If NULL, then the new node will
126    *                    be added at the head of the list.
127    *
128    *  Output: A pointer to the node that was inserted into the list (i.e.,
129    *          the same as <New>).
130    *
131    * ------------------------------------------------------------------------ **
132    */
133   {
134   After = After ? After : (ubi_slNodePtr)ListPtr;
135   New->Next   = After->Next;
136   After->Next = New;
137   if( !(New->Next) )
138     ListPtr->Tail = New;
139   (ListPtr->count)++;
140   return( New );
141   } /* ubi_slInsert */
142
143 ubi_slNodePtr ubi_slRemove( ubi_slListPtr ListPtr, ubi_slNodePtr After )
144   /* ------------------------------------------------------------------------ **
145    * Remove the node followng <After>.  If <After> is NULL, remove from the
146    * head of the list.
147    *
148    *  Input:  ListPtr - A pointer to the list from which the node is to be
149    *                    removed.
150    *          After   - Pointer to the node preceeding the node to be
151    *                    removed.
152    *
153    *  Output: A pointer to the node that was removed, or NULL if the list is
154    *          empty.
155    *
156    * ------------------------------------------------------------------------ **
157    */
158   {
159   ubi_slNodePtr DelNode;
160
161   After   = After ? After : (ubi_slNodePtr)ListPtr;
162   DelNode = After->Next;
163   if( DelNode )
164     {
165     if( !(DelNode->Next) )
166       ListPtr->Tail = After;
167     After->Next  = DelNode->Next;
168     (ListPtr->count)--;
169     }
170   return( DelNode );
171   } /* ubi_slRemove */
172
173 /* ================================ The End ================================= */