1#ifndef _LST_H_
2#define _LST_H_
3
4/*	$OpenBSD: lst.h,v 1.3 2023/09/05 14:05:41 jsg Exp $ */
5/*	$NetBSD: lst.h,v 1.7 1996/11/06 17:59:12 christos Exp $ */
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.
24 * 3. Neither the name of the University nor the names of its contributors
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 *
40 *	from: @(#)lst.h 8.1 (Berkeley) 6/6/93
41 */
42
43/*-
44 * lst.h --
45 *	Header for using the list library
46 */
47
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.  */
51struct ListNode_ {
52	struct ListNode_    *prevPtr;	/* previous element in list */
53	struct ListNode_    *nextPtr;	/* next in list */
54	void		    *datum;	/* datum associated with this element */
55};
56
57#ifndef LIST_TYPE
58#include "lst_t.h"
59#endif
60
61typedef void (*SimpleProc)(void *);
62typedef int (*FindProc)(void *, void *);
63typedef int (*FindProcConst)(void *, const void *);
64typedef void (*ForEachProc)(void *, void *);
65typedef void *(*DuplicateProc)(void *);
66
67/*
68 * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
69 *	not to be freed.
70 * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
71 */
72#define NOFREE		((SimpleProc) 0)
73#define NOCOPY		((DuplicateProc) 0)
74
75/*
76 * Creation/destruction functions
77 */
78/* Create a new list */
79#define Lst_Init(l)	(l)->firstPtr = (l)->lastPtr = NULL
80/* Static lists are already okay */
81#define Static_Lst_Init(l)
82
83/* Duplicate an existing list */
84extern Lst		Lst_Clone(Lst, Lst, DuplicateProc);
85/* Destroy an old one */
86extern void		Lst_Destroy(LIST *, SimpleProc);
87/* True if list is empty */
88#define 	Lst_IsEmpty(l)	((l)->firstPtr == NULL)
89
90/*
91 * Functions to modify a list
92 */
93/* Insert an element before another */
94extern void		Lst_Insert(Lst, LstNode, void *);
95extern void		Lst_AtFront(Lst, void *);
96/* Insert an element after another */
97extern void		Lst_Append(Lst, LstNode, void *);
98extern void		Lst_AtEnd(Lst, void *);
99/* Remove an element */
100extern void		Lst_Remove(Lst, LstNode);
101/* Replace a node with a new value */
102extern void		Lst_Replace(LstNode, void *);
103/* Concatenate two lists, destructive.	*/
104extern void		Lst_ConcatDestroy(Lst, Lst);
105/* Concatenate two lists, non-destructive.  */
106extern void		Lst_Concat(Lst, Lst);
107/* requeue element already in list at front of list */
108extern void		Lst_Requeue(Lst, LstNode);
109
110/*
111 * Node-specific functions
112 */
113/* Return first element in list */
114/* Return last element in list */
115/* Return successor to given element */
116extern LstNode		Lst_Succ(LstNode);
117
118/*
119 * Functions for entire lists
120 */
121/* Find an element starting from somewhere */
122extern LstNode		Lst_FindFrom(LstNode, FindProc, void *);
123/*
124 * See if the given datum is on the list. Returns the LstNode containing
125 * the datum
126 */
127extern LstNode		Lst_Member(Lst, void *);
128/* Apply a function to elements of a lst starting from a certain point.  */
129extern void		Lst_ForEachFrom(LstNode, ForEachProc, void *);
130extern void		Lst_Every(Lst, SimpleProc);
131
132extern bool		Lst_AddNew(Lst, void *);
133/*
134 * for using the list as a queue
135 */
136/* Place an element at tail of queue */
137#define Lst_EnQueue	Lst_AtEnd
138#define Lst_QueueNew	Lst_AddNew
139
140/*
141 * for using the list as a stack
142 */
143#define Lst_Push	Lst_AtFront
144#define Lst_Pop		Lst_DeQueue
145
146/* Remove an element from head of queue */
147extern 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
157static inline LstNode
158Lst_FindConst(Lst l, FindProcConst cProc, const void *d)
159{
160	return Lst_FindFrom(Lst_First(l), (FindProc)cProc, (void *)d);
161}
162
163static inline LstNode
164Lst_FindFromConst(LstNode ln, FindProcConst cProc, const void *d)
165{
166	return Lst_FindFrom(ln, (FindProc)cProc, (void *)d);
167}
168
169#endif /* _LST_H_ */
170