lst.h revision 1.10
1 /* $NetBSD: lst.h,v 1.10 2003/08/07 11:14:53 agc 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 _LST_H_ 81 #define _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 Lst *Lst; 93 typedef struct LstNode *LstNode; 94 95 #define NILLST ((Lst) NIL) 96 #define NILLNODE ((LstNode) NIL) 97 98 /* 99 * NOFREE can be used as the freeProc to Lst_Destroy when the elements are 100 * not to be freed. 101 * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate. 102 */ 103 #define NOFREE ((void (*)(ClientData)) 0) 104 #define NOCOPY ((ClientData (*)(ClientData)) 0) 105 106 #define LST_CONCNEW 0 /* create new LstNode's when using Lst_Concat */ 107 #define LST_CONCLINK 1 /* relink LstNode's when using Lst_Concat */ 108 109 /* 110 * Creation/destruction functions 111 */ 112 /* Create a new list */ 113 Lst Lst_Init(Boolean); 114 /* Duplicate an existing list */ 115 Lst Lst_Duplicate(Lst, ClientData (*)(ClientData)); 116 /* Destroy an old one */ 117 void Lst_Destroy(Lst, void (*)(ClientData)); 118 /* True if list is empty */ 119 Boolean Lst_IsEmpty(Lst); 120 121 /* 122 * Functions to modify a list 123 */ 124 /* Insert an element before another */ 125 ReturnStatus Lst_Insert(Lst, LstNode, ClientData); 126 /* Insert an element after another */ 127 ReturnStatus Lst_Append(Lst, LstNode, ClientData); 128 /* Place an element at the front of a lst. */ 129 ReturnStatus Lst_AtFront(Lst, ClientData); 130 /* Place an element at the end of a lst. */ 131 ReturnStatus Lst_AtEnd(Lst, ClientData); 132 /* Remove an element */ 133 ReturnStatus Lst_Remove(Lst, LstNode); 134 /* Replace a node with a new value */ 135 ReturnStatus Lst_Replace(LstNode, ClientData); 136 /* Concatenate two lists */ 137 ReturnStatus Lst_Concat(Lst, Lst, int); 138 139 /* 140 * Node-specific functions 141 */ 142 /* Return first element in list */ 143 LstNode Lst_First(Lst); 144 /* Return last element in list */ 145 LstNode Lst_Last(Lst); 146 /* Return successor to given element */ 147 LstNode Lst_Succ(LstNode); 148 /* Get datum from LstNode */ 149 ClientData Lst_Datum(LstNode); 150 151 /* 152 * Functions for entire lists 153 */ 154 /* Find an element in a list */ 155 LstNode Lst_Find(Lst, ClientData, int (*)(ClientData, ClientData)); 156 /* Find an element starting from somewhere */ 157 LstNode Lst_FindFrom(Lst, LstNode, ClientData, 158 int (*cProc)(ClientData, ClientData)); 159 /* 160 * See if the given datum is on the list. Returns the LstNode containing 161 * the datum 162 */ 163 LstNode Lst_Member(Lst, ClientData); 164 /* Apply a function to all elements of a lst */ 165 void Lst_ForEach(Lst, int (*)(ClientData, ClientData), ClientData); 166 /* 167 * Apply a function to all elements of a lst starting from a certain point. 168 * If the list is circular, the application will wrap around to the 169 * beginning of the list again. 170 */ 171 void Lst_ForEachFrom(Lst, LstNode, int (*)(ClientData, ClientData), 172 ClientData); 173 /* 174 * these functions are for dealing with a list as a table, of sorts. 175 * An idea of the "current element" is kept and used by all the functions 176 * between Lst_Open() and Lst_Close(). 177 */ 178 /* Open the list */ 179 ReturnStatus Lst_Open(Lst); 180 /* Next element please */ 181 LstNode Lst_Next(Lst); 182 /* Done yet? */ 183 Boolean Lst_IsAtEnd(Lst); 184 /* Finish table access */ 185 void Lst_Close(Lst); 186 187 /* 188 * for using the list as a queue 189 */ 190 /* Place an element at tail of queue */ 191 ReturnStatus Lst_EnQueue(Lst, ClientData); 192 /* Remove an element from head of queue */ 193 ClientData Lst_DeQueue(Lst); 194 195 #endif /* _LST_H_ */ 196
Indexes created Thu Sep 25 16:09:42 GMT 2025