Annotation of src/usr.bin/make/lst.h, Revision 1.31
1.20 espie 1: #ifndef _LST_H_
2: #define _LST_H_
3:
1.31 ! espie 4: /* $OpenBSD: lst.h,v 1.30 2015/10/14 13:50:22 espie Exp $ */
1.19 espie 5: /* $NetBSD: lst.h,v 1.7 1996/11/06 17:59:12 christos Exp $ */
1.1 deraadt 6:
7: /*
8: * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
9: * Copyright (c) 1988, 1989 by Adam de Boor
10: * Copyright (c) 1989 by Berkeley Softworks
11: * All rights reserved.
12: *
13: * This code is derived from software contributed to Berkeley by
14: * Adam de Boor.
15: *
16: * Redistribution and use in source and binary forms, with or without
17: * modification, are permitted provided that the following conditions
18: * are met:
19: * 1. Redistributions of source code must retain the above copyright
20: * notice, this list of conditions and the following disclaimer.
21: * 2. Redistributions in binary form must reproduce the above copyright
22: * notice, this list of conditions and the following disclaimer in the
23: * documentation and/or other materials provided with the distribution.
1.25 millert 24: * 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 25: * may be used to endorse or promote products derived from this software
26: * without specific prior written permission.
27: *
28: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38: * SUCH DAMAGE.
39: *
1.19 espie 40: * from: @(#)lst.h 8.1 (Berkeley) 6/6/93
1.1 deraadt 41: */
42:
43: /*-
44: * lst.h --
45: * Header for using the list library
46: */
47:
1.14 espie 48: /* These data structures are PRIVATE !!!
49: * Here for efficiency, so that some functions can be recoded as inlines,
50: * and so that lst headers don't need dynamic allocation most of the time. */
1.20 espie 51: struct ListNode_ {
1.19 espie 52: struct ListNode_ *prevPtr; /* previous element in list */
53: struct ListNode_ *nextPtr; /* next in list */
1.14 espie 54: void *datum; /* datum associated with this element */
1.20 espie 55: };
1.14 espie 56:
1.20 espie 57: #ifndef LIST_TYPE
58: #include "lst_t.h"
59: #endif
1.1 deraadt 60:
1.19 espie 61: typedef void (*SimpleProc)(void *);
1.30 espie 62: typedef bool (*FindProc)(void *, void *);
1.19 espie 63: typedef int (*FindProcConst)(void *, const void *);
64: typedef void (*ForEachProc)(void *, void *);
65: typedef void *(*DuplicateProc)(void *);
1.1 deraadt 66:
67: /*
68: * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
69: * not to be freed.
1.19 espie 70: * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
1.1 deraadt 71: */
1.19 espie 72: #define NOFREE ((SimpleProc) 0)
73: #define NOCOPY ((DuplicateProc) 0)
1.1 deraadt 74:
75: /*
1.19 espie 76: * Creation/destruction functions
1.1 deraadt 77: */
1.16 espie 78: /* Create a new list */
1.24 espie 79: #define Lst_Init(l) (l)->firstPtr = (l)->lastPtr = NULL
80: /* Static lists are already okay */
81: #define Static_Lst_Init(l)
82:
1.19 espie 83: /* Duplicate an existing list */
84: extern Lst Lst_Clone(Lst, Lst, DuplicateProc);
1.16 espie 85: /* Destroy an old one */
1.19 espie 86: extern void Lst_Destroy(LIST *, SimpleProc);
1.1 deraadt 87: /* True if list is empty */
1.19 espie 88: #define Lst_IsEmpty(l) ((l)->firstPtr == NULL)
1.1 deraadt 89:
90: /*
1.19 espie 91: * Functions to modify a list
1.1 deraadt 92: */
93: /* Insert an element before another */
1.19 espie 94: extern void Lst_Insert(Lst, LstNode, void *);
95: extern void Lst_AtFront(Lst, void *);
1.1 deraadt 96: /* Insert an element after another */
1.19 espie 97: extern void Lst_Append(Lst, LstNode, void *);
98: extern void Lst_AtEnd(Lst, void *);
1.1 deraadt 99: /* Remove an element */
1.19 espie 100: extern void Lst_Remove(Lst, LstNode);
1.1 deraadt 101: /* Replace a node with a new value */
1.19 espie 102: extern void Lst_Replace(LstNode, void *);
103: /* Concatenate two lists, destructive. */
104: extern void Lst_ConcatDestroy(Lst, Lst);
105: /* Concatenate two lists, non-destructive. */
106: extern void Lst_Concat(Lst, Lst);
1.27 espie 107: /* requeue element already in list at front of list */
108: extern void Lst_Requeue(Lst, LstNode);
1.1 deraadt 109:
110: /*
1.19 espie 111: * Node-specific functions
1.1 deraadt 112: */
113: /* Return first element in list */
114: /* Return last element in list */
115: /* Return successor to given element */
1.19 espie 116: extern LstNode Lst_Succ(LstNode);
1.1 deraadt 117:
118: /*
1.19 espie 119: * Functions for entire lists
1.1 deraadt 120: */
121: /* Find an element starting from somewhere */
1.19 espie 122: extern LstNode Lst_FindFrom(LstNode, FindProc, void *);
1.1 deraadt 123: /*
1.19 espie 124: * See if the given datum is on the list. Returns the LstNode containing
125: * the datum
1.1 deraadt 126: */
1.19 espie 127: extern LstNode Lst_Member(Lst, void *);
128: /* Apply a function to elements of a lst starting from a certain point. */
129: extern void Lst_ForEachFrom(LstNode, ForEachProc, void *);
130: extern void Lst_Every(Lst, SimpleProc);
1.1 deraadt 131:
1.20 espie 132: extern bool Lst_AddNew(Lst, void *);
1.1 deraadt 133: /*
1.19 espie 134: * for using the list as a queue
1.1 deraadt 135: */
136: /* Place an element at tail of queue */
1.19 espie 137: #define Lst_EnQueue Lst_AtEnd
138: #define Lst_QueueNew Lst_AddNew
139:
1.20 espie 140: /*
141: * for using the list as a stack
142: */
143: #define Lst_Push Lst_AtFront
144: #define Lst_Pop Lst_DeQueue
145:
1.1 deraadt 146: /* Remove an element from head of queue */
1.19 espie 147: extern void * Lst_DeQueue(Lst);
148:
149: #define Lst_Datum(ln) ((ln)->datum)
150: #define Lst_First(l) ((l)->firstPtr)
151: #define Lst_Last(l) ((l)->lastPtr)
152: #define Lst_ForEach(l, proc, d) Lst_ForEachFrom(Lst_First(l), proc, d)
153: #define Lst_Find(l, cProc, d) Lst_FindFrom(Lst_First(l), cProc, d)
154: #define Lst_Adv(ln) ((ln)->nextPtr)
155: #define Lst_Rev(ln) ((ln)->prevPtr)
156:
157:
1.20 espie 158: /* Inlines are preferable to macros here because of the type checking. */
1.19 espie 159: #ifdef HAS_INLINES
160: static INLINE LstNode
161: Lst_FindConst(Lst l, FindProcConst cProc, const void *d)
162: {
163: return Lst_FindFrom(Lst_First(l), (FindProc)cProc, (void *)d);
164: }
165:
166: static INLINE LstNode
167: Lst_FindFromConst(LstNode ln, FindProcConst cProc, const void *d)
168: {
169: return Lst_FindFrom(ln, (FindProc)cProc, (void *)d);
170: }
171: #else
172: #define Lst_FindConst(l, cProc, d) \
173: Lst_FindFrom(Lst_First(l), (FindProc)cProc, (void *)d)
174: #define Lst_FindFromConst(ln, cProc, d) \
175: Lst_FindFrom(ln, (FindProc)cProc, (void *)d)
176: #endif
1.1 deraadt 177:
178: #endif /* _LST_H_ */
![[BACK]](/icons/back.gif){kind=icon}
Return to lst.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / make