summaryrefslogtreecommitdiff
path: root/source3/ubiqx/ubi_sLinkList.h
blob: 7d546f06e95f26a30d3fb4d1bd886168c6a54569 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
#ifndef ubi_sLinkList_H
#define ubi_sLinkList_H
/* ========================================================================== **
 *                              ubi_sLinkList.h
 *
 *  Copyright (C) 1997 by Christopher R. Hertel
 *
 *  Email: crh@ubiqx.mn.org
 * -------------------------------------------------------------------------- **
 *  This module implements a really simple singly-linked list.
 * -------------------------------------------------------------------------- **
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the Free
 *  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * -------------------------------------------------------------------------- **
 *
 * Revision 0.2  1997/10/21 03:36:14  crh
 * Added parameter <After> in function Insert().  Made necessary changes
 * to macro AddHead() and added macro AddHere().
 *
 * Revision 0.1  1997/10/16 02:54:08  crh
 * Initial Revision.
 *
 * ========================================================================== **
 */

#include <stdlib.h>


/* ========================================================================== **
 * Typedefs...
 *
 *  ubi_slNode    - This is the basic node structure.
 *  ubi_slNodePtr - Pointer to a node.
 *  ubi_slList    - This is the list header structure.
 *  ubi_slListPtr - Pointer to a List (i.e., a list header structure).
 *
 */

typedef struct ubi_slListNode
  {
  struct ubi_slListNode *Next;
  } ubi_slNode;

typedef ubi_slNode *ubi_slNodePtr;

typedef struct
  {
  ubi_slNodePtr Head;
  unsigned long count;
  } ubi_slList;

typedef ubi_slList *ubi_slListPtr;

/* ========================================================================== **
 * Macros...
 * 
 *  ubi_slAddHead - Add a new node at the head of the list.
 *  ubi_slRemHead - Remove the node at the head of the list, if any.
 *  ubi_slFirst   - Return a pointer to the first node in the list, if any.
 *  ubi_slNext    - Given a node, return a pointer to the next node.
 *
 *  Note that all of these provide type casting of the parameters.  The
 *  Add and Rem macros are nothing more than nice front-ends to the
 *  Insert and Remove operations.
 *
 */

#define ubi_slAddHead( L, N ) \
        ubi_slInsert( (ubi_slListPtr)(L), (ubi_slNodePtr)(N), NULL )

#define ubi_slAddHere( L, N, P ) \
        ubi_slInsert( (ubi_slListPtr)(L), \
                      (ubi_slNodePtr)(N), \
                      (ubi_slNodePtr)(P) )

#define ubi_slRemHead( L ) ubi_slRemove( (ubi_slListPtr)(L) )

#define ubi_slFirst( L ) (((ubi_slListPtr)(L))->Head)

#define ubi_slNext( N )  (((ubi_slNodePtr)(N))->Next)


/* ========================================================================== **
 * Function prototypes...
 */

ubi_slListPtr ubi_slInitList( ubi_slListPtr ListPtr );
  /* ------------------------------------------------------------------------ **
   * Initialize a singly-linked list header.
   *
   *  Input:  ListPtr - A pointer to the list structure that is to be
   *                    initialized for use.
   *
   *  Output: A pointer to the initialized list header (i.e., same as
   *          <ListPtr>).
   *
   * ------------------------------------------------------------------------ **
   */

ubi_slNodePtr ubi_slInsert( ubi_slListPtr ListPtr,
                            ubi_slNodePtr New,
                            ubi_slNodePtr After );
  /* ------------------------------------------------------------------------ **
   * Insert a new node at the head of the list.
   *
   *  Input:  ListPtr - A pointer to the list into which the node is to
   *                    be inserted.
   *          New     - Pointer to the node that is to be added to the list.
   *          After   - Pointer to a list in a node after which the new node
   *                    will be inserted.  If NULL, then the new node will
   *                    be added at the head of the list.
   *
   *  Output: A pointer to the node that was inserted into the list (i.e.,
   *          the same as <New>).
   *
   * ------------------------------------------------------------------------ **
   */

ubi_slNodePtr ubi_slRemove( ubi_slListPtr ListPtr );
  /* ------------------------------------------------------------------------ **
   * Remove a node from the head of the list.
   *
   *  Input:  ListPtr - A pointer to the list from which the node is to be
   *                    removed.
   *
   *  Output: A pointer to the node that was removed.
   *
   * ------------------------------------------------------------------------ **
   */

/* ================================ The End ================================= */
#endif /* ubi_sLinkList_H */