2 * Copyright (c) 1988, 1989, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1988, 1989 by Adam de Boor
5 * Copyright (c) 1989 by Berkeley Softworks
8 * This code is derived from software contributed to Berkeley by
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * from: @(#)lst.h 8.1 (Berkeley) 6/6/93
40 * $FreeBSD: src/usr.bin/make/lst.h,v 1.9 1999/08/28 01:03:32 peter Exp $
41 * $DragonFly: src/usr.bin/make/lst.h,v 1.12 2004/12/16 23:24:09 okumoto Exp $
46 * Header for using the list library
51 #include <sys/param.h>
56 * Structure of a list node.
59 struct LstNode *prevPtr; /* previous element in list */
60 struct LstNode *nextPtr; /* next in list */
61 int useCount:8; /* Count of functions using the node. Node may not
62 * be deleted until count goes to 0 */
63 int flags:8; /* Node status flags */
64 void *datum; /* datum associated with this element */
66 typedef struct LstNode *LstNode;
69 * Flags required for synchronization
71 #define LN_DELETED 0x0001 /* List node should be removed when done */
74 LstHead, LstMiddle, LstTail, LstUnknown
81 LstNode firstPtr; /* first node in list */
82 LstNode lastPtr; /* last node in list */
84 * fields for sequential access
86 LstWhere atEnd; /* Where in the list the last access was */
87 Boolean isOpen; /* true if list has been Lst_Open'ed */
88 LstNode curPtr; /* current node, if open. NULL if
90 LstNode prevPtr; /* Previous node, if open. Used by
93 typedef struct Lst *Lst;
95 typedef int CompareProc(void *, void *);
96 typedef int DoProc(void *, void *);
97 typedef void *DuplicateProc(void *);
98 typedef void FreeProc(void *);
101 * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
103 * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
105 #define NOFREE ((FreeProc *)NULL)
106 #define NOCOPY ((DuplicateProc *)NULL)
108 #define LST_CONCNEW 0 /* create new LstNode's when using Lst_Concat */
109 #define LST_CONCLINK 1 /* relink LstNode's when using Lst_Concat */
112 * Creation/destruction functions
114 /* Create a new list */
116 /* Duplicate an existing list */
117 Lst Lst_Duplicate(Lst, DuplicateProc *);
118 /* Destroy an old one */
119 void Lst_Destroy(Lst, FreeProc *);
122 * Functions to modify a list
124 /* Insert an element before another */
125 ReturnStatus Lst_Insert(Lst, LstNode, void *);
126 /* Insert an element after another */
127 ReturnStatus Lst_Append(Lst, LstNode, void *);
128 /* Place an element at the front of a lst. */
129 #define Lst_AtFront(LST, D) (Lst_Insert((LST), Lst_First(LST), (D)))
130 /* Place an element at the end of a lst. */
131 #define Lst_AtEnd(LST, D) (Lst_Append((LST), Lst_Last(LST), (D)))
132 /* Remove an element */
133 ReturnStatus Lst_Remove(Lst, LstNode);
134 /* Replace a node with a new value */
135 #define Lst_Replace(NODE, D) (((NODE) == NULL) ? FAILURE : \
136 (((NODE)->datum = (D)), SUCCESS))
137 /* Concatenate two lists */
138 ReturnStatus Lst_Concat(Lst, Lst, int);
141 * Node-specific functions
143 /* Return first element in list */
144 #define Lst_First(LST) ((Lst_Valid(LST) && !Lst_IsEmpty(LST)) \
145 ? (LST)->firstPtr : NULL)
146 /* Return last element in list */
147 #define Lst_Last(LST) ((Lst_Valid(LST) && !Lst_IsEmpty(LST)) \
148 ? (LST)->lastPtr : NULL)
149 /* Return successor to given element */
150 #define Lst_Succ(NODE) (((NODE) == NULL) ? NULL : (NODE)->nextPtr)
151 /* Get datum from LstNode */
152 #define Lst_Datum(NODE) ((NODE)->datum)
155 * Functions for entire lists
157 /* Find an element in a list */
158 #define Lst_Find(LST, D, FN) (Lst_FindFrom((LST), Lst_First(LST), (D), (FN)))
159 /* Find an element starting from somewhere */
160 LstNode Lst_FindFrom(Lst, LstNode, void *, CompareProc *);
162 * See if the given datum is on the list. Returns the LstNode containing
165 LstNode Lst_Member(Lst, void *);
166 /* Apply a function to all elements of a lst */
167 void Lst_ForEach(Lst, DoProc *, void *);
168 #define Lst_ForEach(LST, FN, D) (Lst_ForEachFrom((LST), Lst_First(LST), \
171 * Apply a function to all elements of a lst starting from a certain point.
172 * If the list is circular, the application will wrap around to the
173 * beginning of the list again.
175 void Lst_ForEachFrom(Lst, LstNode, DoProc *, void *);
177 * these functions are for dealing with a list as a table, of sorts.
178 * An idea of the "current element" is kept and used by all the functions
179 * between Lst_Open() and Lst_Close().
182 ReturnStatus Lst_Open(Lst);
183 /* Next element please */
184 LstNode Lst_Next(Lst);
186 Boolean Lst_IsAtEnd(Lst);
187 /* Finish table access */
191 * for using the list as a queue
193 /* Place an element at tail of queue */
194 #define Lst_EnQueue(LST, D) (Lst_Valid(LST) \
195 ? Lst_Append((LST), Lst_Last(LST), (D)) \
197 /* Remove an element from head of queue */
198 void * Lst_DeQueue(Lst);
202 * Return TRUE if the list L is valid
204 #define Lst_Valid(L) (((L) == NULL) ? FALSE : TRUE)
207 * LstNodeValid (LN, L) --
208 * Return TRUE if the LstNode LN is valid with respect to L
210 #define Lst_NodeValid(LN, L) (((LN) == NULL) ? FALSE : TRUE)
214 * TRUE if the list L is empty.
216 #define Lst_IsEmpty(L) (!Lst_Valid(L) || (L)->firstPtr == NULL)