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  *      @(#)lst.h       8.2 (Berkeley) 4/28/95
  40  * $FreeBSD$
  41  */
  42
  43 #ifndef lst_h_38f3ead1
  44 #define lst_h_38f3ead1
  45
  46 /*-
  47  * lst.h --
  48  *      Header for using the list library
  49  */
  50
  51 #include "util.h"
  52
  53 /*
  54  * Structure of a list node.
  55  */
  56 struct LstNode {
  57         struct LstNode  *prevPtr;   /* previous element in list */
  58         struct LstNode  *nextPtr;   /* next in list */
  59         void            *datum;     /* datum associated with this element */
  60 };
  61 typedef struct  LstNode LstNode;
  62
  63 /*
  64  * The list itself
  65  */
  66 struct Lst {
  67         LstNode         *firstPtr; /* first node in list */
  68         LstNode         *lastPtr;  /* last node in list */
  69 };
  70 typedef struct  Lst Lst;
  71
  72 typedef void *DuplicateProc(void *);
  73 typedef void FreeProc(void *);
  74
  75 /*
  76  * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
  77  *      not to be freed.
  78  * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
  79  */
  80 #define NOFREE          ((FreeProc *)NULL)
  81 #define NOCOPY          ((DuplicateProc *)NULL)
  82
  83 #define LST_CONCNEW     0   /* create new LstNode's when using Lst_Concat */
  84 #define LST_CONCLINK    1   /* relink LstNode's when using Lst_Concat */
  85
  86 /*
  87  * Creation/destruction functions
  88  */
  89 /* Create a new list */
  90 #define Lst_Init(LST)   do {                                            \
  91                                 (LST)->firstPtr = NULL;                 \
  92                                 (LST)->lastPtr = NULL;                  \
  93                         } while (0)
  94 #define Lst_Initializer(NAME)   { NULL, NULL }
  95
  96 /* Duplicate an existing list */
  97 void    Lst_Duplicate(Lst *, Lst *, DuplicateProc *);
  98
  99 /* Destroy an old one */
 100 void    Lst_Destroy(Lst *, FreeProc *);
 101
 102 /*
 103  * Functions to modify a list
 104  */
 105 /* Insert an element before another */
 106 void            Lst_Insert(Lst *, LstNode *, void *);
 107 /* Insert an element after another */
 108 void            Lst_Append(Lst *, LstNode *, void *);
 109 /* Place an element at the front of a lst. */
 110 #define Lst_AtFront(LST, D)     (Lst_Insert((LST), Lst_First(LST), (D)))
 111 /* Place an element at the end of a lst. */
 112 #define Lst_AtEnd(LST, D)       (Lst_Append((LST), Lst_Last(LST), (D)))
 113 /* Remove an element */
 114 void            Lst_Remove(Lst *, LstNode *);
 115 /* Replace a node with a new value */
 116 #define Lst_Replace(NODE, D)    ((void)((NODE)->datum = (D)))
 117 /* Concatenate two lists */
 118 void    Lst_Concat(Lst *, Lst *, int);
 119
 120 /*
 121  * Node-specific functions
 122  */
 123 /* Return first element in list */
 124 #define Lst_First(LST)  ((Lst_Valid(LST) && !Lst_IsEmpty(LST)) \
 125                             ? (LST)->firstPtr : NULL)
 126 /* Return last element in list */
 127 #define Lst_Last(LST)   ((Lst_Valid(LST) && !Lst_IsEmpty(LST)) \
 128                             ? (LST)->lastPtr : NULL)
 129 /* Return successor to given element */
 130 #define Lst_Succ(NODE)  (((NODE) == NULL) ? NULL : (NODE)->nextPtr)
 131 #define LST_NEXT(NODE)  ((NODE)->nextPtr)
 132 /* Get datum from LstNode */
 133 #define Lst_Datum(NODE) ((NODE)->datum)
 134
 135 /*
 136  * Functions for entire lists
 137  */
 138
 139 /*
 140  * See if the given datum is on the list. Returns the LstNode containing
 141  * the datum
 142  */
 143 LstNode         *Lst_Member(Lst *, void *);
 144
 145 /* Loop through a list. Note, that you may not delete the list element. */
 146 #define LST_FOREACH(PTR, LST)                                           \
 147         for ((PTR) = (LST)->firstPtr; (PTR) != NULL; (PTR) = (PTR)->nextPtr)
 148
 149 /*
 150  * for using the list as a queue
 151  */
 152 /* Place an element at tail of queue */
 153 #define Lst_EnQueue(LST, D)     (Lst_Valid(LST) \
 154                                     ? Lst_Append((LST), Lst_Last(LST), (D)) \
 155                                     : (void)0)
 156 /* Remove an element from head of queue */
 157 void            *Lst_DeQueue(Lst *);
 158
 159 /*
 160  * LstValid (L) --
 161  *      Return TRUE if the list L is valid
 162  */
 163 #define Lst_Valid(L)    (((L) == NULL) ? FALSE : TRUE)
 164
 165 /*
 166  * LstNodeValid (LN, L) --
 167  *      Return TRUE if the LstNode LN is valid with respect to L
 168  */
 169 #define Lst_NodeValid(LN, L)    (((LN) == NULL) ? FALSE : TRUE)
 170
 171 /*
 172  * Lst_IsEmpty(L) --
 173  *      TRUE if the list L is empty.
 174  */
 175 #define Lst_IsEmpty(L)  (!Lst_Valid(L) || (L)->firstPtr == NULL)
 176
 177 #endif /* lst_h_38f3ead1 */