Annotation of src/usr.bin/make/lst.h, Revision 1.11
1.11 ! espie 1: /* $OpenBSD: lst.h,v 1.10 1999/12/18 21:58:07 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:
57: /*
58: * basic typedef. This is what the Lst_ functions handle
59: */
60:
61: typedef struct Lst *Lst;
62: typedef struct LstNode *LstNode;
1.11 ! espie 63: typedef int (*FindProc)__P((ClientData, ClientData));
1.1 deraadt 64:
65: /*
66: * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
67: * not to be freed.
68: * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
69: */
70: #define NOFREE ((void (*) __P((ClientData))) 0)
71: #define NOCOPY ((ClientData (*) __P((ClientData))) 0)
72:
73: #define LST_CONCNEW 0 /* create new LstNode's when using Lst_Concat */
74: #define LST_CONCLINK 1 /* relink LstNode's when using Lst_Concat */
75:
76: /*
77: * Creation/destruction functions
78: */
79: /* Create a new list */
1.8 espie 80: Lst Lst_Init __P((void));
1.1 deraadt 81: /* Duplicate an existing list */
82: Lst Lst_Duplicate __P((Lst, ClientData (*)(ClientData)));
83: /* Destroy an old one */
84: void Lst_Destroy __P((Lst, void (*)(ClientData)));
85: /* True if list is empty */
86: Boolean Lst_IsEmpty __P((Lst));
87:
88: /*
89: * Functions to modify a list
90: */
91: /* Insert an element before another */
1.10 espie 92: void Lst_Insert __P((Lst, LstNode, ClientData));
1.1 deraadt 93: /* Insert an element after another */
1.10 espie 94: void Lst_Append __P((Lst, LstNode, ClientData));
1.1 deraadt 95: /* Place an element at the front of a lst. */
1.10 espie 96: void Lst_AtFront __P((Lst, ClientData));
1.1 deraadt 97: /* Place an element at the end of a lst. */
1.10 espie 98: void Lst_AtEnd __P((Lst, ClientData));
1.1 deraadt 99: /* Remove an element */
1.10 espie 100: void Lst_Remove __P((Lst, LstNode));
1.1 deraadt 101: /* Replace a node with a new value */
1.10 espie 102: void Lst_Replace __P((LstNode, ClientData));
1.1 deraadt 103: /* Concatenate two lists */
1.10 espie 104: void Lst_Concat __P((Lst, Lst, int));
1.1 deraadt 105:
106: /*
107: * Node-specific functions
108: */
109: /* Return first element in list */
110: LstNode Lst_First __P((Lst));
111: /* Return last element in list */
112: LstNode Lst_Last __P((Lst));
113: /* Return successor to given element */
114: LstNode Lst_Succ __P((LstNode));
115: /* Get datum from LstNode */
116: ClientData Lst_Datum __P((LstNode));
117:
118: /*
119: * Functions for entire lists
120: */
1.11 ! espie 121:
1.1 deraadt 122: /* Find an element in a list */
1.11 ! espie 123: #define Lst_Find(l, cProc, d) Lst_FindFrom(Lst_First(l), cProc, d)
! 124:
1.1 deraadt 125: /* Find an element starting from somewhere */
1.11 ! espie 126: LstNode Lst_FindFrom __P((LstNode, FindProc, ClientData));
1.4 millert 127: /*
1.1 deraadt 128: * See if the given datum is on the list. Returns the LstNode containing
129: * the datum
130: */
131: LstNode Lst_Member __P((Lst, ClientData));
132: /* Apply a function to all elements of a lst */
133: void Lst_ForEach __P((Lst, int (*)(ClientData, ClientData),
134: ClientData));
135: /*
136: * Apply a function to all elements of a lst starting from a certain point.
137: * If the list is circular, the application will wrap around to the
138: * beginning of the list again.
139: */
140: void Lst_ForEachFrom __P((Lst, LstNode,
141: int (*)(ClientData, ClientData),
142: ClientData));
143: /*
144: * these functions are for dealing with a list as a table, of sorts.
145: * An idea of the "current element" is kept and used by all the functions
146: * between Lst_Open() and Lst_Close().
147: */
148: /* Open the list */
149: ReturnStatus Lst_Open __P((Lst));
150: /* Next element please */
151: LstNode Lst_Next __P((Lst));
152: /* Done yet? */
153: Boolean Lst_IsAtEnd __P((Lst));
154: /* Finish table access */
155: void Lst_Close __P((Lst));
156:
157: /*
158: * for using the list as a queue
159: */
160: /* Place an element at tail of queue */
1.10 espie 161: void Lst_EnQueue __P((Lst, ClientData));
1.1 deraadt 162: /* Remove an element from head of queue */
163: ClientData Lst_DeQueue __P((Lst));
164:
165: #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