1 #ifndef _LST_H_ 2 #define _LST_H_ 3 4 /* $OpenBSD: lst.h,v 1.30 2015/10/14 13:50:22 espie 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. */ 51 struct 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 61 typedef void (*SimpleProc)(void *); 62 typedef bool (*FindProc)(void *, void *); 63 typedef int (*ForEachNodeWhileProc)(LstNode, void *); 64 typedef int (*FindProcConst)(void *, const void *); 65 typedef void (*ForEachProc)(void *, void *); 66 typedef void *(*DuplicateProc)(void *); 67 68 /* 69 * NOFREE can be used as the freeProc to Lst_Destroy when the elements are 70 * not to be freed. 71 * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate. 72 */ 73 #define NOFREE ((SimpleProc) 0) 74 #define NOCOPY ((DuplicateProc) 0) 75 76 /* 77 * Creation/destruction functions 78 */ 79 /* Create a new list */ 80 #define Lst_Init(l) (l)->firstPtr = (l)->lastPtr = NULL 81 /* Static lists are already okay */ 82 #define Static_Lst_Init(l) 83 84 /* Duplicate an existing list */ 85 extern Lst Lst_Clone(Lst, Lst, DuplicateProc); 86 /* Destroy an old one */ 87 extern void Lst_Destroy(LIST *, SimpleProc); 88 /* True if list is empty */ 89 #define Lst_IsEmpty(l) ((l)->firstPtr == NULL) 90 91 /* 92 * Functions to modify a list 93 */ 94 /* Insert an element before another */ 95 extern void Lst_Insert(Lst, LstNode, void *); 96 extern void Lst_AtFront(Lst, void *); 97 /* Insert an element after another */ 98 extern void Lst_Append(Lst, LstNode, void *); 99 extern void Lst_AtEnd(Lst, void *); 100 /* Remove an element */ 101 extern void Lst_Remove(Lst, LstNode); 102 /* Replace a node with a new value */ 103 extern void Lst_Replace(LstNode, void *); 104 /* Concatenate two lists, destructive. */ 105 extern void Lst_ConcatDestroy(Lst, Lst); 106 /* Concatenate two lists, non-destructive. */ 107 extern void Lst_Concat(Lst, Lst); 108 /* requeue element already in list at front of list */ 109 extern void Lst_Requeue(Lst, LstNode); 110 111 /* 112 * Node-specific functions 113 */ 114 /* Return first element in list */ 115 /* Return last element in list */ 116 /* Return successor to given element */ 117 extern LstNode Lst_Succ(LstNode); 118 119 /* 120 * Functions for entire lists 121 */ 122 /* Find an element starting from somewhere */ 123 extern LstNode Lst_FindFrom(LstNode, FindProc, void *); 124 /* 125 * See if the given datum is on the list. Returns the LstNode containing 126 * the datum 127 */ 128 extern LstNode Lst_Member(Lst, void *); 129 /* Apply a function to elements of a lst starting from a certain point. */ 130 extern void Lst_ForEachFrom(LstNode, ForEachProc, void *); 131 extern void Lst_Every(Lst, SimpleProc); 132 133 extern void Lst_ForEachNodeWhile(Lst, ForEachNodeWhileProc, void *); 134 135 extern bool Lst_AddNew(Lst, void *); 136 /* 137 * for using the list as a queue 138 */ 139 /* Place an element at tail of queue */ 140 #define Lst_EnQueue Lst_AtEnd 141 #define Lst_QueueNew Lst_AddNew 142 143 /* 144 * for using the list as a stack 145 */ 146 #define Lst_Push Lst_AtFront 147 #define Lst_Pop Lst_DeQueue 148 149 /* Remove an element from head of queue */ 150 extern void * Lst_DeQueue(Lst); 151 152 #define Lst_Datum(ln) ((ln)->datum) 153 #define Lst_First(l) ((l)->firstPtr) 154 #define Lst_Last(l) ((l)->lastPtr) 155 #define Lst_ForEach(l, proc, d) Lst_ForEachFrom(Lst_First(l), proc, d) 156 #define Lst_Find(l, cProc, d) Lst_FindFrom(Lst_First(l), cProc, d) 157 #define Lst_Adv(ln) ((ln)->nextPtr) 158 #define Lst_Rev(ln) ((ln)->prevPtr) 159 160 161 /* Inlines are preferable to macros here because of the type checking. */ 162 #ifdef HAS_INLINES 163 static INLINE LstNode 164 Lst_FindConst(Lst l, FindProcConst cProc, const void *d) 165 { 166 return Lst_FindFrom(Lst_First(l), (FindProc)cProc, (void *)d); 167 } 168 169 static INLINE LstNode 170 Lst_FindFromConst(LstNode ln, FindProcConst cProc, const void *d) 171 { 172 return Lst_FindFrom(ln, (FindProc)cProc, (void *)d); 173 } 174 #else 175 #define Lst_FindConst(l, cProc, d) \ 176 Lst_FindFrom(Lst_First(l), (FindProc)cProc, (void *)d) 177 #define Lst_FindFromConst(ln, cProc, d) \ 178 Lst_FindFrom(ln, (FindProc)cProc, (void *)d) 179 #endif 180 181 #endif /* _LST_H_ */ 182