lst.h revision 1.67
1 /* $NetBSD: lst.h,v 1.67 2020/09/25 04:18:11 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 element in list */ 92 ListNode *next; /* next in list */ 93 uint8_t priv_useCount; /* Count of functions using the node. 94 * node may not be deleted until count 95 * goes to 0 */ 96 Boolean priv_deleted; /* List node should be removed when done */ 97 union { 98 void *datum; /* datum associated with this element */ 99 const struct GNode *priv_gnode; /* alias, just for debugging */ 100 const char *priv_str; /* alias, just for debugging */ 101 }; 102 }; 103 104 typedef enum { 105 Head, Middle, Tail, Unknown 106 } ListForEachUntilWhere; 107 108 struct List { 109 ListNode *first; /* first node in list */ 110 ListNode *last; /* last node in list */ 111 112 /* fields for sequential access */ 113 Boolean priv_isOpen; /* true if list has been Lst_Open'ed */ 114 ListForEachUntilWhere priv_lastAccess; 115 ListNode *priv_curr; /* current node, if open. NULL if 116 * *just* opened */ 117 ListNode *priv_prev; /* Previous node, if open. Used by Lst_Remove */ 118 }; 119 120 /* Copy a node, usually by allocating a copy of the given object. 121 * For reference-counted objects, the original object may need to be 122 * modified, therefore the parameter is not const. */ 123 typedef void *LstCopyProc(void *); 124 /* Free the datum of a node, called before freeing the node itself. */ 125 typedef void LstFreeProc(void *); 126 /* Return TRUE if the datum matches the args, for Lst_Find. */ 127 typedef Boolean LstFindProc(const void *datum, const void *args); 128 /* An action for Lst_ForEach. */ 129 typedef void LstActionProc(void *datum, void *args); 130 /* An action for Lst_ForEachUntil. */ 131 typedef int LstActionUntilProc(void *datum, void *args); 132 133 /* Create or destroy a list */ 134 135 /* Create a new list. */ 136 List *Lst_Init(void); 137 /* Duplicate an existing list. */ 138 List *Lst_Copy(List *, LstCopyProc); 139 /* Free the list, leaving the node data unmodified. */ 140 void Lst_Free(List *); 141 /* Free the list, freeing the node data using the given function. */ 142 void Lst_Destroy(List *, LstFreeProc); 143 144 /* Get information about a list */ 145 146 static inline MAKE_ATTR_UNUSED Boolean 147 Lst_IsEmpty(List *list) { return list->first == NULL; } 148 /* Return the first node of the list, or NULL if the list is empty. */ 149 static inline MAKE_ATTR_UNUSED ListNode * 150 Lst_First(List *list) { return list->first; } 151 /* Return the last node of the list, or NULL if the list is empty. */ 152 static inline MAKE_ATTR_UNUSED ListNode * 153 Lst_Last(List *list) { return list->last; } 154 /* Find the first node for which the function returns TRUE, or NULL. */ 155 ListNode *Lst_Find(List *, LstFindProc, const void *); 156 /* Find the first node for which the function returns TRUE, or NULL. 157 * The search starts at the given node, towards the end of the list. */ 158 ListNode *Lst_FindFrom(List *, ListNode *, LstFindProc, const void *); 159 /* Find the first node that contains the given datum, or NULL. */ 160 ListNode *Lst_FindDatum(List *, const void *); 161 162 /* Modify a list */ 163 164 /* Insert a datum before the given node. */ 165 void Lst_InsertBefore(List *, ListNode *, void *); 166 /* Place a datum at the front of the list. */ 167 void Lst_Prepend(List *, void *); 168 /* Place a datum at the end of the list. */ 169 void Lst_Append(List *, void *); 170 /* Remove the node from the list. */ 171 void Lst_Remove(List *, ListNode *); 172 void Lst_PrependAll(List *, List *); 173 void Lst_AppendAll(List *, List *); 174 void Lst_MoveAll(List *, List *); 175 176 /* Node-specific functions */ 177 178 /* Return the successor of the node, or NULL. */ 179 static inline MAKE_ATTR_UNUSED ListNode * 180 LstNode_Next(ListNode *node) { return node->next; } 181 /* Return the predecessor of the node, or NULL. */ 182 static inline MAKE_ATTR_UNUSED ListNode * 183 LstNode_Prev(ListNode *node) { return node->prev; } 184 /* Return the datum of the node. Usually not NULL. */ 185 static inline MAKE_ATTR_UNUSED void * 186 LstNode_Datum(ListNode *node) { return node->datum; } 187 /* Replace the value of the node. */ 188 void LstNode_Set(ListNode *, void *); 189 /* Set the value of the node to NULL. Having NULL in a list is unusual. */ 190 void LstNode_SetNull(ListNode *); 191 192 /* Iterating over a list, using a callback function */ 193 194 /* Apply a function to each datum of the list. 195 * The function must not modify the structure of the list, for example by 196 * adding or removing nodes. */ 197 void Lst_ForEach(List *, LstActionProc, void *); 198 /* Apply a function to each datum of the list, until the callback function 199 * returns non-zero. */ 200 int Lst_ForEachUntil(List *, LstActionUntilProc, void *); 201 202 /* Iterating over a list while keeping track of the current node and possible 203 * concurrent modifications */ 204 205 /* Start iterating the list. */ 206 void Lst_Open(List *); 207 /* Return the next node, or NULL. */ 208 ListNode *Lst_Next(List *); 209 /* Finish iterating the list. */ 210 void Lst_Close(List *); 211 212 /* Using the list as a queue */ 213 214 /* Add a datum at the tail of the queue. */ 215 void Lst_Enqueue(List *, void *); 216 /* Remove the head node of the queue and return its datum. */ 217 void *Lst_Dequeue(List *); 218 219 /* A stack is a very simple collection of items that only allows access to the 220 * top-most item. */ 221 typedef struct { 222 void **items; 223 size_t len; 224 size_t cap; 225 } Stack; 226 227 void Stack_Init(Stack *); 228 Boolean Stack_IsEmpty(Stack *); 229 void Stack_Push(Stack *, void *); 230 void *Stack_Pop(Stack *); 231 void Stack_Done(Stack *); 232 233 #endif /* MAKE_LST_H */ 234
Indexes created Wed Sep 24 05:09:52 GMT 2025