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.20 2005/02/01 22:05:36 okumoto Exp $
44 #ifndef lst_h_38f3ead1
45 #define lst_h_38f3ead1
49 * Header for using the list library
55 * Structure of a list node.
58 struct LstNode *prevPtr; /* previous element in list */
59 struct LstNode *nextPtr; /* next in list */
60 int useCount:8; /* Count of functions using the node. Node may not
61 * be deleted until count goes to 0 */
62 int flags:8; /* Node status flags */
63 void *datum; /* datum associated with this element */
65 typedef struct LstNode LstNode;
68 * Flags required for synchronization
70 #define LN_DELETED 0x0001 /* List node should be removed when done */
73 LstHead, LstMiddle, LstTail, LstUnknown
80 LstNode *firstPtr; /* first node in list */
81 LstNode *lastPtr; /* last node in list */
83 typedef struct Lst Lst;
85 typedef int CompareProc(const void *, const void *);
86 typedef int DoProc(void *, void *);
87 typedef void *DuplicateProc(void *);
88 typedef void FreeProc(void *);
91 * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
93 * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
95 #define NOFREE ((FreeProc *)NULL)
96 #define NOCOPY ((DuplicateProc *)NULL)
98 #define LST_CONCNEW 0 /* create new LstNode's when using Lst_Concat */
99 #define LST_CONCLINK 1 /* relink LstNode's when using Lst_Concat */
102 * Creation/destruction functions
104 /* Create a new list */
105 #define Lst_Init(LST) do { \
106 (LST)->firstPtr = NULL; \
107 (LST)->lastPtr = NULL; \
109 #define Lst_Initializer(NAME) { NULL, NULL }
111 /* Duplicate an existing list */
112 void Lst_Duplicate(Lst *, Lst *, DuplicateProc *);
114 /* Destroy an old one */
115 void Lst_Destroy(Lst *, FreeProc *);
118 * Functions to modify a list
120 /* Insert an element before another */
121 void Lst_Insert(Lst *, LstNode *, void *);
122 /* Insert an element after another */
123 void Lst_Append(Lst *, LstNode *, void *);
124 /* Place an element at the front of a lst. */
125 #define Lst_AtFront(LST, D) (Lst_Insert((LST), Lst_First(LST), (D)))
126 /* Place an element at the end of a lst. */
127 #define Lst_AtEnd(LST, D) (Lst_Append((LST), Lst_Last(LST), (D)))
128 /* Remove an element */
129 void Lst_Remove(Lst *, LstNode *);
130 /* Replace a node with a new value */
131 #define Lst_Replace(NODE, D) (((NODE) == NULL) ? FAILURE : \
132 (((NODE)->datum = (D)), SUCCESS))
133 /* Concatenate two lists */
134 void Lst_Concat(Lst *, Lst *, int);
137 * Node-specific functions
139 /* Return first element in list */
140 #define Lst_First(LST) ((Lst_Valid(LST) && !Lst_IsEmpty(LST)) \
141 ? (LST)->firstPtr : NULL)
142 /* Return last element in list */
143 #define Lst_Last(LST) ((Lst_Valid(LST) && !Lst_IsEmpty(LST)) \
144 ? (LST)->lastPtr : NULL)
145 /* Return successor to given element */
146 #define Lst_Succ(NODE) (((NODE) == NULL) ? NULL : (NODE)->nextPtr)
147 /* Get datum from LstNode */
148 #define Lst_Datum(NODE) ((NODE)->datum)
151 * Functions for entire lists
153 /* Find an element in a list */
154 #define Lst_Find(LST, D, FN) (Lst_FindFrom((LST), Lst_First(LST), (D), (FN)))
155 /* Find an element starting from somewhere */
156 LstNode *Lst_FindFrom(Lst *, LstNode *, const void *, CompareProc *);
158 * See if the given datum is on the list. Returns the LstNode containing
161 LstNode *Lst_Member(Lst *, void *);
162 /* Apply a function to all elements of a lst */
163 void Lst_ForEach(Lst *, DoProc *, void *);
164 #define Lst_ForEach(LST, FN, D) (Lst_ForEachFrom((LST), Lst_First(LST), \
167 * Apply a function to all elements of a lst starting from a certain point.
168 * If the list is circular, the application will wrap around to the
169 * beginning of the list again.
171 void Lst_ForEachFrom(Lst *, LstNode *, DoProc *, void *);
174 * for using the list as a queue
176 /* Place an element at tail of queue */
177 #define Lst_EnQueue(LST, D) (Lst_Valid(LST) \
178 ? Lst_Append((LST), Lst_Last(LST), (D)) \
180 /* Remove an element from head of queue */
181 void *Lst_DeQueue(Lst *);
185 * Return TRUE if the list L is valid
187 #define Lst_Valid(L) (((L) == NULL) ? FALSE : TRUE)
190 * LstNodeValid (LN, L) --
191 * Return TRUE if the LstNode LN is valid with respect to L
193 #define Lst_NodeValid(LN, L) (((LN) == NULL) ? FALSE : TRUE)
197 * TRUE if the list L is empty.
199 #define Lst_IsEmpty(L) (!Lst_Valid(L) || (L)->firstPtr == NULL)
201 #endif /* lst_h_38f3ead1 */