Annotation of src/usr.bin/make/lst.h, Revision 1.15
1.15 ! espie 1: /* $OpenBSD: lst.h,v 1.14 2000/06/17 14:34:04 espie Exp $ */
1.4 millert 2: /* $NetBSD: lst.h,v 1.7 1996/11/06 17:59:12 christos Exp $ */
1.1 deraadt 3:
4: /*
5: * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
6: * Copyright (c) 1988, 1989 by Adam de Boor
7: * Copyright (c) 1989 by Berkeley Softworks
8: * All rights reserved.
9: *
10: * This code is derived from software contributed to Berkeley by
11: * Adam de Boor.
12: *
13: * Redistribution and use in source and binary forms, with or without
14: * modification, are permitted provided that the following conditions
15: * are met:
16: * 1. Redistributions of source code must retain the above copyright
17: * notice, this list of conditions and the following disclaimer.
18: * 2. Redistributions in binary form must reproduce the above copyright
19: * notice, this list of conditions and the following disclaimer in the
20: * documentation and/or other materials provided with the distribution.
21: * 3. All advertising materials mentioning features or use of this software
22: * must display the following acknowledgement:
23: * This product includes software developed by the University of
24: * California, Berkeley and its contributors.
25: * 4. Neither the name of the University nor the names of its contributors
26: * may be used to endorse or promote products derived from this software
27: * without specific prior written permission.
28: *
29: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39: * SUCH DAMAGE.
40: *
1.4 millert 41: * from: @(#)lst.h 8.1 (Berkeley) 6/6/93
1.1 deraadt 42: */
43:
44: /*-
45: * lst.h --
46: * Header for using the list library
47: */
48: #ifndef _LST_H_
49: #define _LST_H_
50:
1.7 deraadt 51: #include "sprite.h"
1.2 niklas 52: #include <sys/param.h>
1.5 mickey 53: #ifdef __STDC__
1.1 deraadt 54: #include <stdlib.h>
55: #endif
56:
1.14 espie 57: /* These data structures are PRIVATE !!!
58: * Here for efficiency, so that some functions can be recoded as inlines,
59: * and so that lst headers don't need dynamic allocation most of the time. */
60: typedef struct ListNode_ {
61: struct ListNode_ *prevPtr; /* previous element in list */
62: struct ListNode_ *nextPtr; /* next in list */
63: short useCount:8, /* Count of functions using the node.
64: * node may not be deleted until count
65: * goes to 0 */
66: flags:8; /* Node status flags */
67: void *datum; /* datum associated with this element */
68: } *LstNode;
69:
70: typedef enum {
71: Head, Middle, Tail, Unknown
72: } Where;
73:
74: typedef struct {
75: LstNode firstPtr; /* first node in list */
76: LstNode lastPtr; /* last node in list */
77: /*
78: * fields for sequential access
79: */
80: Where atEnd; /* Where in the list the last access was */
81: Boolean isOpen; /* true if list has been Lst_Open'ed */
82: LstNode curPtr; /* current node, if open. NULL if
83: * *just* opened */
84: LstNode prevPtr; /* Previous node, if open. Used by
85: * Lst_Remove */
86: } LIST;
87:
88: typedef LIST *Lst;
1.1 deraadt 89: /*
90: * basic typedef. This is what the Lst_ functions handle
91: */
92:
1.13 espie 93: typedef int (*FindProc) __P((void *, void *));
94: typedef void (*SimpleProc) __P((void *));
95: typedef void (*ForEachProc) __P((void *, void *));
96: typedef void * (*DuplicateProc) __P((void *));
1.1 deraadt 97:
98: /*
99: * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
100: * not to be freed.
101: * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
102: */
1.12 espie 103: #define NOFREE ((SimpleProc)0)
104: #define NOCOPY ((DuplicateProc)0)
1.1 deraadt 105:
106: #define LST_CONCNEW 0 /* create new LstNode's when using Lst_Concat */
107: #define LST_CONCLINK 1 /* relink LstNode's when using Lst_Concat */
108:
109: /*
110: * Creation/destruction functions
111: */
1.15 ! espie 112: /* CTOR/DTOR, ala C++ */
! 113: void Lst_Init __P((Lst));
! 114: void Lst_Destroy __P((Lst, SimpleProc));
! 115:
1.1 deraadt 116: /* Create a new list */
1.15 ! espie 117: Lst Lst_New __P((void));
! 118: /* Destroy an old one */
! 119: void Lst_Delete __P((Lst, SimpleProc));
1.1 deraadt 120: /* Duplicate an existing list */
1.12 espie 121: Lst Lst_Duplicate __P((Lst, DuplicateProc));
1.1 deraadt 122: /* True if list is empty */
123: Boolean Lst_IsEmpty __P((Lst));
124:
125: /*
126: * Functions to modify a list
127: */
128: /* Insert an element before another */
1.13 espie 129: void Lst_Insert __P((Lst, LstNode, void *));
1.1 deraadt 130: /* Insert an element after another */
1.13 espie 131: void Lst_Append __P((Lst, LstNode, void *));
1.1 deraadt 132: /* Place an element at the front of a lst. */
1.13 espie 133: void Lst_AtFront __P((Lst, void *));
1.1 deraadt 134: /* Place an element at the end of a lst. */
1.13 espie 135: void Lst_AtEnd __P((Lst, void *));
1.1 deraadt 136: /* Remove an element */
1.10 espie 137: void Lst_Remove __P((Lst, LstNode));
1.1 deraadt 138: /* Replace a node with a new value */
1.13 espie 139: void Lst_Replace __P((LstNode, void *));
1.1 deraadt 140: /* Concatenate two lists */
1.10 espie 141: void Lst_Concat __P((Lst, Lst, int));
1.1 deraadt 142:
143: /*
144: * Node-specific functions
145: */
146: /* Return first element in list */
147: LstNode Lst_First __P((Lst));
148: /* Return last element in list */
149: LstNode Lst_Last __P((Lst));
150: /* Return successor to given element */
151: LstNode Lst_Succ __P((LstNode));
152: /* Get datum from LstNode */
1.13 espie 153: void * Lst_Datum __P((LstNode));
1.1 deraadt 154:
155: /*
156: * Functions for entire lists
157: */
1.11 espie 158:
1.1 deraadt 159: /* Find an element in a list */
1.11 espie 160: #define Lst_Find(l, cProc, d) Lst_FindFrom(Lst_First(l), cProc, d)
161:
1.1 deraadt 162: /* Find an element starting from somewhere */
1.13 espie 163: LstNode Lst_FindFrom __P((LstNode, FindProc, void *));
1.12 espie 164:
165: /* Apply a function to all elements of a lst */
166: #define Lst_ForEach(l, proc, d) Lst_ForEachFrom(Lst_First(l), proc, d)
167: /* Apply a function to all elements of a lst starting from a certain point. */
1.13 espie 168: void Lst_ForEachFrom __P((LstNode, ForEachProc, void *));
1.12 espie 169: void Lst_Every __P((Lst, SimpleProc));
170:
171:
1.4 millert 172: /*
1.1 deraadt 173: * See if the given datum is on the list. Returns the LstNode containing
174: * the datum
175: */
1.13 espie 176: LstNode Lst_Member __P((Lst, void *));
1.12 espie 177:
1.1 deraadt 178: /*
179: * these functions are for dealing with a list as a table, of sorts.
180: * An idea of the "current element" is kept and used by all the functions
181: * between Lst_Open() and Lst_Close().
182: */
183: /* Open the list */
184: ReturnStatus Lst_Open __P((Lst));
185: /* Next element please */
186: LstNode Lst_Next __P((Lst));
187: /* Done yet? */
188: Boolean Lst_IsAtEnd __P((Lst));
189: /* Finish table access */
190: void Lst_Close __P((Lst));
191:
192: /*
193: * for using the list as a queue
194: */
195: /* Place an element at tail of queue */
1.13 espie 196: void Lst_EnQueue __P((Lst, void *));
1.1 deraadt 197: /* Remove an element from head of queue */
1.13 espie 198: void * Lst_DeQueue __P((Lst));
1.1 deraadt 199:
200: #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