1/*	$NetBSD: lst.h,v 1.105 2024/04/27 17:33:46 rillig Exp $	*/
2
3/*
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 *	from: @(#)lst.h	8.1 (Berkeley) 6/6/93
35 */
36
37/*
38 * Copyright (c) 1988, 1989 by Adam de Boor
39 * Copyright (c) 1989 by Berkeley Softworks
40 * All rights reserved.
41 *
42 * This code is derived from software contributed to Berkeley by
43 * Adam de Boor.
44 *
45 * Redistribution and use in source and binary forms, with or without
46 * modification, are permitted provided that the following conditions
47 * are met:
48 * 1. Redistributions of source code must retain the above copyright
49 *    notice, this list of conditions and the following disclaimer.
50 * 2. Redistributions in binary form must reproduce the above copyright
51 *    notice, this list of conditions and the following disclaimer in the
52 *    documentation and/or other materials provided with the distribution.
53 * 3. All advertising materials mentioning features or use of this software
54 *    must display the following acknowledgement:
55 *	This product includes software developed by the University of
56 *	California, Berkeley and its contributors.
57 * 4. Neither the name of the University nor the names of its contributors
58 *    may be used to endorse or promote products derived from this software
59 *    without specific prior written permission.
60 *
61 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
62 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
63 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
64 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
65 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
66 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
67 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
68 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
69 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
70 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
71 * SUCH DAMAGE.
72 *
73 *	from: @(#)lst.h	8.1 (Berkeley) 6/6/93
74 */
75
76/* Doubly-linked lists of arbitrary pointers. */
77
78#ifndef MAKE_LST_H
79#define MAKE_LST_H
80
81#ifdef HAVE_INTTYPES_H
82#include <inttypes.h>
83#elif defined(HAVE_STDINT_H)
84#include <stdint.h>
85#endif
86#ifdef HAVE_STDLIB_H
87#include <stdlib.h>
88#endif
89
90/* A doubly-linked list of pointers. */
91typedef struct List List;
92/* A single node in the doubly-linked list. */
93typedef struct ListNode ListNode;
94
95struct ListNode {
96	ListNode *prev;		/* previous node in list, or NULL */
97	ListNode *next;		/* next node in list, or NULL */
98	void *datum;		/* datum associated with this element */
99};
100
101struct List {
102	ListNode *first;
103	ListNode *last;
104};
105
106/* Free the list nodes. */
107void Lst_Done(List *);
108/* Free the list nodes, as well as each node's datum. */
109void Lst_DoneFree(List *);
110
111#define LST_INIT { NULL, NULL }
112
113/* Initialize a list, without memory allocation. */
114MAKE_INLINE void
115Lst_Init(List *list)
116{
117	list->first = NULL;
118	list->last = NULL;
119}
120
121/* Get information about a list */
122
123MAKE_INLINE bool MAKE_ATTR_USE
124Lst_IsEmpty(List *list)
125{
126	return list->first == NULL;
127}
128
129/* Find the first node that contains the given datum, or NULL. */
130ListNode *Lst_FindDatum(List *, const void *) MAKE_ATTR_USE;
131
132/* Modify a list */
133
134/* Insert a datum before the given node. */
135void Lst_InsertBefore(List *, ListNode *, void *);
136/* Add a datum at the head of the list. */
137void Lst_Prepend(List *, void *);
138/* Add a datum at the tail of the list. */
139void Lst_Append(List *, void *);
140/* Remove the node from the list. */
141void Lst_Remove(List *, ListNode *);
142void Lst_PrependAll(List *, List *);
143void Lst_AppendAll(List *, List *);
144void Lst_MoveAll(List *, List *);
145
146/* Node-specific functions */
147
148/* Replace the value of the node. */
149void LstNode_Set(ListNode *, void *);
150/* Set the value of the node to NULL. Having NULL in a list is unusual. */
151void LstNode_SetNull(ListNode *);
152
153/* Using the list as a queue */
154
155/* Add a datum at the tail of the queue. */
156MAKE_INLINE void
157Lst_Enqueue(List *list, void *datum)
158{
159	Lst_Append(list, datum);
160}
161
162/* Remove the head node of the queue and return its datum. */
163void *Lst_Dequeue(List *) MAKE_ATTR_USE;
164
165/*
166 * A vector is an ordered collection of items, allowing for fast indexed
167 * access.
168 */
169typedef struct Vector {
170	void *items;		/* memory holding the items */
171	size_t itemSize;	/* size of a single item */
172	size_t len;		/* number of actually usable elements */
173	size_t cap;		/* capacity */
174} Vector;
175
176void Vector_Init(Vector *, size_t);
177
178/*
179 * Return the pointer to the given item in the vector.
180 * The returned data is valid until the next modifying operation.
181 */
182MAKE_INLINE void * MAKE_ATTR_USE
183Vector_Get(Vector *v, size_t i)
184{
185	unsigned char *items = v->items;
186	return items + i * v->itemSize;
187}
188
189void *Vector_Push(Vector *);
190void *Vector_Pop(Vector *);
191
192MAKE_INLINE void
193Vector_Done(Vector *v)
194{
195	free(v->items);
196}
197
198#endif
199