lst.h revision 1.38
1 /* $NetBSD: lst.h,v 1.38 2020/08/22 22:57:53 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 /*- 77 * lst.h -- 78 * Header for using the list library 79 */ 80 #ifndef MAKE_LST_H 81 #define MAKE_LST_H 82 83 #include <sys/param.h> 84 #include <stdlib.h> 85 86 #include "sprite.h" 87 88 /* 89 * basic typedef. This is what the Lst_ functions handle 90 */ 91 92 typedef struct List *Lst; 93 typedef struct ListNode *LstNode; 94 95 typedef void *DuplicateProc(void *); 96 typedef void FreeProc(void *); 97 98 /* 99 * Creation/destruction functions 100 */ 101 /* Create a new list */ 102 Lst Lst_Init(void); 103 /* Duplicate an existing list */ 104 Lst Lst_CopyS(Lst, DuplicateProc *); 105 /* Destroy an old one */ 106 void Lst_Destroy(Lst, FreeProc *); 107 /* True if list is empty */ 108 Boolean Lst_IsEmpty(Lst); 109 110 /* 111 * Functions to modify a list 112 */ 113 /* Insert an element before another */ 114 void Lst_InsertBeforeS(Lst, LstNode, void *); 115 /* Place an element at the front of a lst. */ 116 ReturnStatus Lst_AtFront(Lst, void *); 117 void Lst_PrependS(Lst, void *); 118 /* Place an element at the end of a lst. */ 119 void Lst_AppendS(Lst, void *); 120 /* Remove an element */ 121 void Lst_RemoveS(Lst, LstNode); 122 /* Replace a node with a new value */ 123 void Lst_ReplaceS(LstNode, void *); 124 void Lst_PrependAllS(Lst, Lst); 125 void Lst_AppendAllS(Lst, Lst); 126 void Lst_MoveAllS(Lst, Lst); 127 128 /* 129 * Node-specific functions 130 */ 131 /* Return first element in list */ 132 LstNode Lst_First(Lst); 133 /* Return last element in list */ 134 LstNode Lst_Last(Lst); 135 /* Return successor to given element */ 136 LstNode Lst_Succ(LstNode); 137 /* Return predecessor to given element */ 138 LstNode Lst_PrevS(LstNode); 139 /* Get datum from LstNode */ 140 void *Lst_DatumS(LstNode); 141 142 /* 143 * Functions for entire lists 144 */ 145 /* Find an element in a list */ 146 LstNode Lst_Find(Lst, const void *, int (*)(const void *, const void *)); 147 /* Find an element starting from somewhere */ 148 LstNode Lst_FindFrom(Lst, LstNode, const void *, 149 int (*cmp)(const void *, const void *)); 150 /* 151 * See if the given datum is on the list. Returns the LstNode containing 152 * the datum 153 */ 154 LstNode Lst_MemberS(Lst, void *); 155 /* Apply a function to all elements of a lst */ 156 int Lst_ForEach(Lst, int (*)(void *, void *), void *); 157 /* Apply a function to all elements of a lst starting from a certain point. */ 158 int Lst_ForEachFrom(Lst, LstNode, int (*)(void *, void *), 159 void *); 160 /* 161 * these functions are for dealing with a list as a table, of sorts. 162 * An idea of the "current element" is kept and used by all the functions 163 * between Lst_Open() and Lst_Close(). 164 */ 165 /* Open the list */ 166 ReturnStatus Lst_Open(Lst); 167 void Lst_OpenS(Lst); 168 /* Next element please, or NULL */ 169 LstNode Lst_NextS(Lst); 170 /* Finish table access */ 171 void Lst_CloseS(Lst); 172 173 /* 174 * for using the list as a queue 175 */ 176 /* Place an element at tail of queue */ 177 void Lst_EnqueueS(Lst, void *); 178 /* Remove an element from head of queue */ 179 void *Lst_DequeueS(Lst); 180 181 #endif /* MAKE_LST_H */ 182
Indexes created Fri Sep 26 20:09:58 GMT 2025