usr.bin/make/lst.h

   1 /*
   2  * Copyright (c) 1988, 1989, 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1988, 1989 by Adam de Boor
   5  * Copyright (c) 1989 by Berkeley Softworks
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Adam de Boor.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      from: @(#)lst.h 8.1 (Berkeley) 6/6/93
  40  * $FreeBSD: src/usr.bin/make/lst.h,v 1.9 1999/08/28 01:03:32 peter Exp $
  41  * $DragonFly: src/usr.bin/make/lst.h,v 1.18 2004/12/17 08:13:30 okumoto Exp $
  42  */
  43
  44 /*-
  45  * lst.h --
  46  *      Header for using the list library
  47  */
  48 #ifndef _LST_H_
  49 #define _LST_H_
  50
  51 #include        <sys/param.h>
  52 #include        <stdlib.h>
  53 #include        "sprite.h"
  54
  55 /*
  56  * Structure of a list node.
  57  */
  58 struct LstNode {
  59         struct LstNode  *prevPtr;   /* previous element in list */
  60         struct LstNode  *nextPtr;   /* next in list */
  61         int     useCount:8; /* Count of functions using the node. Node may not
  62                              * be deleted until count goes to 0 */
  63         int     flags:8;    /* Node status flags */
  64         void    *datum;     /* datum associated with this element */
  65 };
  66 typedef struct  LstNode LstNode;
  67
  68 /*
  69  * Flags required for synchronization
  70  */
  71 #define LN_DELETED      0x0001      /* List node should be removed when done */
  72
  73 typedef enum {
  74         LstHead, LstMiddle, LstTail, LstUnknown
  75 } LstWhere;
  76
  77 /*
  78  * The list itself
  79  */
  80 struct Lst {
  81         LstNode         *firstPtr; /* first node in list */
  82         LstNode         *lastPtr;  /* last node in list */
  83 };
  84 typedef struct  Lst Lst;
  85
  86 typedef int CompareProc(const void *, const void *);
  87 typedef int DoProc(void *, void *);
  88 typedef void *DuplicateProc(void *);
  89 typedef void FreeProc(void *);
  90
  91 /*
  92  * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
  93  *      not to be freed.
  94  * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
  95  */
  96 #define NOFREE          ((FreeProc *)NULL)
  97 #define NOCOPY          ((DuplicateProc *)NULL)
  98
  99 #define LST_CONCNEW     0   /* create new LstNode's when using Lst_Concat */
 100 #define LST_CONCLINK    1   /* relink LstNode's when using Lst_Concat */
 101
 102 /*
 103  * Creation/destruction functions
 104  */
 105 /* Create a new list */
 106 #define Lst_Init(LST)   do {                                            \
 107                                 (LST)->firstPtr = NULL;                 \
 108                                 (LST)->lastPtr = NULL;                  \
 109                         } while (0)
 110 #define Lst_Initializer(NAME)   { NULL, NULL }
 111
 112 /* Duplicate an existing list */
 113 void    Lst_Duplicate(Lst *, Lst *, DuplicateProc *);
 114
 115 /* Destroy an old one */
 116 void    Lst_Destroy(Lst *, FreeProc *);
 117
 118 /*
 119  * Functions to modify a list
 120  */
 121 /* Insert an element before another */
 122 void            Lst_Insert(Lst *, LstNode *, void *);
 123 /* Insert an element after another */
 124 void            Lst_Append(Lst *, LstNode *, void *);
 125 /* Place an element at the front of a lst. */
 126 #define Lst_AtFront(LST, D)     (Lst_Insert((LST), Lst_First(LST), (D)))
 127 /* Place an element at the end of a lst. */
 128 #define Lst_AtEnd(LST, D)       (Lst_Append((LST), Lst_Last(LST), (D)))
 129 /* Remove an element */
 130 void            Lst_Remove(Lst *, LstNode *);
 131 /* Replace a node with a new value */
 132 #define Lst_Replace(NODE, D)    (((NODE) == NULL) ? FAILURE : \
 133                                     (((NODE)->datum = (D)), SUCCESS))
 134 /* Concatenate two lists */
 135 void    Lst_Concat(Lst *, Lst *, int);
 136
 137 /*
 138  * Node-specific functions
 139  */
 140 /* Return first element in list */
 141 #define Lst_First(LST)  ((Lst_Valid(LST) && !Lst_IsEmpty(LST)) \
 142                             ? (LST)->firstPtr : NULL)
 143 /* Return last element in list */
 144 #define Lst_Last(LST)   ((Lst_Valid(LST) && !Lst_IsEmpty(LST)) \
 145                             ? (LST)->lastPtr : NULL)
 146 /* Return successor to given element */
 147 #define Lst_Succ(NODE)  (((NODE) == NULL) ? NULL : (NODE)->nextPtr)
 148 /* Get datum from LstNode */
 149 #define Lst_Datum(NODE) ((NODE)->datum)
 150
 151 /*
 152  * Functions for entire lists
 153  */
 154 /* Find an element in a list */
 155 #define Lst_Find(LST, D, FN)    (Lst_FindFrom((LST), Lst_First(LST), (D), (FN)))
 156 /* Find an element starting from somewhere */
 157 LstNode         *Lst_FindFrom(Lst *, LstNode *, const void *, CompareProc *);
 158 /*
 159  * See if the given datum is on the list. Returns the LstNode containing
 160  * the datum
 161  */
 162 LstNode         *Lst_Member(Lst *, void *);
 163 /* Apply a function to all elements of a lst */
 164 void            Lst_ForEach(Lst *, DoProc *, void *);
 165 #define Lst_ForEach(LST, FN, D) (Lst_ForEachFrom((LST), Lst_First(LST), \
 166                                     (FN), (D)))
 167 /*
 168  * Apply a function to all elements of a lst starting from a certain point.
 169  * If the list is circular, the application will wrap around to the
 170  * beginning of the list again.
 171  */
 172 void            Lst_ForEachFrom(Lst *, LstNode *, DoProc *, void *);
 173
 174 /*
 175  * for using the list as a queue
 176  */
 177 /* Place an element at tail of queue */
 178 #define Lst_EnQueue(LST, D)     (Lst_Valid(LST) \
 179                                     ? Lst_Append((LST), Lst_Last(LST), (D)) \
 180                                     : FAILURE)
 181 /* Remove an element from head of queue */
 182 void            *Lst_DeQueue(Lst *);
 183
 184 /*
 185  * LstValid (L) --
 186  *      Return TRUE if the list L is valid
 187  */
 188 #define Lst_Valid(L)    (((L) == NULL) ? FALSE : TRUE)
 189
 190 /*
 191  * LstNodeValid (LN, L) --
 192  *      Return TRUE if the LstNode LN is valid with respect to L
 193  */
 194 #define Lst_NodeValid(LN, L)    (((LN) == NULL) ? FALSE : TRUE)
 195
 196 /*
 197  * Lst_IsEmpty(L) --
 198  *      TRUE if the list L is empty.
 199  */
 200 #define Lst_IsEmpty(L)  (!Lst_Valid(L) || (L)->firstPtr == NULL)
 201
 202
 203 #endif /* _LST_H_ */