lst.h revision 1.78
1 /* $NetBSD: lst.h,v 1.78 2020/10/23 04:58:33 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 #include <sys/param.h> 82 #include <stdint.h> 83 #include <stdlib.h> 84 85 /* A doubly-linked list of pointers. */ 86 typedef struct List List; 87 /* A single node in the doubly-linked list. */ 88 typedef struct ListNode ListNode; 89 90 struct ListNode { 91 ListNode *prev; /* previous node in list, or NULL */ 92 ListNode *next; /* next node in list, or NULL */ 93 union { 94 void *datum; /* datum associated with this element */ 95 const struct GNode *priv_gnode; /* alias, just for debugging */ 96 const char *priv_str; /* alias, just for debugging */ 97 }; 98 }; 99 100 struct List { 101 ListNode *first; /* first node in list */ 102 ListNode *last; /* last node in list */ 103 }; 104 105 /* Copy a node, usually by allocating a copy of the given object. 106 * For reference-counted objects, the original object may need to be 107 * modified, therefore the parameter is not const. */ 108 typedef void *LstCopyProc(void *); 109 /* Free the datum of a node, called before freeing the node itself. */ 110 typedef void LstFreeProc(void *); 111 /* Return TRUE if the datum matches the args, for Lst_Find. */ 112 typedef Boolean LstFindProc(const void *datum, const void *args); 113 /* An action for Lst_ForEachUntil and Lst_ForEachUntilConcurrent. */ 114 typedef int LstActionUntilProc(void *datum, void *args); 115 116 /* Create or destroy a list */ 117 118 /* Create a new list. */ 119 List *Lst_New(void); 120 /* Duplicate an existing list. */ 121 List *Lst_Copy(List *, LstCopyProc); 122 /* Free the list, leaving the node data unmodified. */ 123 void Lst_Free(List *); 124 /* Free the list, freeing the node data using the given function. */ 125 void Lst_Destroy(List *, LstFreeProc); 126 127 /* Get information about a list */ 128 129 static inline MAKE_ATTR_UNUSED Boolean 130 Lst_IsEmpty(List *list) { return list->first == NULL; } 131 132 /* Find the first node for which the function returns TRUE, or NULL. */ 133 ListNode *Lst_Find(List *, LstFindProc, const void *); 134 /* Find the first node for which the function returns TRUE, or NULL. 135 * The search starts at the given node, towards the end of the list. */ 136 ListNode *Lst_FindFrom(List *, ListNode *, LstFindProc, const void *); 137 /* Find the first node that contains the given datum, or NULL. */ 138 ListNode *Lst_FindDatum(List *, const void *); 139 140 /* Modify a list */ 141 142 /* Insert a datum before the given node. */ 143 void Lst_InsertBefore(List *, ListNode *, void *); 144 /* Place a datum at the front of the list. */ 145 void Lst_Prepend(List *, void *); 146 /* Place a datum at the end of the list. */ 147 void Lst_Append(List *, void *); 148 /* Remove the node from the list. */ 149 void Lst_Remove(List *, ListNode *); 150 void Lst_PrependAll(List *, List *); 151 void Lst_AppendAll(List *, List *); 152 void Lst_MoveAll(List *, List *); 153 154 /* Node-specific functions */ 155 156 /* Replace the value of the node. */ 157 void LstNode_Set(ListNode *, void *); 158 /* Set the value of the node to NULL. Having NULL in a list is unusual. */ 159 void LstNode_SetNull(ListNode *); 160 161 /* Iterating over a list, using a callback function */ 162 163 /* Run the action for each datum of the list, until the action returns 164 * non-zero. 165 * 166 * During this iteration, the list must not be modified structurally. */ 167 int Lst_ForEachUntil(List *, LstActionUntilProc, void *); 168 169 /* Iterating over a list while keeping track of the current node and possible 170 * concurrent modifications */ 171 172 /* Using the list as a queue */ 173 174 /* Add a datum at the tail of the queue. */ 175 void Lst_Enqueue(List *, void *); 176 /* Remove the head node of the queue and return its datum. */ 177 void *Lst_Dequeue(List *); 178 179 /* A vector is an ordered collection of items, allowing fast indexed access. */ 180 typedef struct Vector { 181 void **items; 182 size_t len; 183 size_t cap; 184 } Vector; 185 186 void Vector_Init(Vector *); 187 Boolean Vector_IsEmpty(Vector *); 188 void Vector_Push(Vector *, void *); 189 void *Vector_Pop(Vector *); 190 void Vector_Done(Vector *); 191 192 #endif /* MAKE_LST_H */ 193
Indexes created Fri Sep 26 08:10:20 GMT 2025