usr.bin/make/lst.lib/lstInt.h

   1 /*
   2  * Copyright (c) 1988, 1989, 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Adam de Boor.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      from: @(#)lstInt.h      8.1 (Berkeley) 6/6/93
  37  * $FreeBSD: src/usr.bin/make/lst.lib/lstInt.h,v 1.7 1999/08/28 01:03:53 peter Exp $
  38  * $DragonFly: src/usr.bin/make/lst.lib/Attic/lstInt.h,v 1.2 2003/06/17 04:29:29 dillon Exp $
  39  */
  40
  41 /*-
  42  * lstInt.h --
  43  *      Internals for the list library
  44  */
  45 #ifndef _LSTINT_H_
  46 #define _LSTINT_H_
  47
  48 #include          "make.h"
  49 #include          "lst.h"
  50
  51 typedef struct ListNode {
  52         struct ListNode *prevPtr;   /* previous element in list */
  53         struct ListNode *nextPtr;   /* next in list */
  54         short           useCount:8, /* Count of functions using the node.
  55                                      * node may not be deleted until count
  56                                      * goes to 0 */
  57                         flags:8;    /* Node status flags */
  58         ClientData      datum;      /* datum associated with this element */
  59 } *ListNode;
  60 /*
  61  * Flags required for synchronization
  62  */
  63 #define LN_DELETED      0x0001      /* List node should be removed when done */
  64
  65 #define NilListNode     ((ListNode)-1)
  66
  67 typedef enum {
  68     Head, Middle, Tail, Unknown
  69 } Where;
  70
  71 typedef struct  {
  72         ListNode        firstPtr; /* first node in list */
  73         ListNode        lastPtr;  /* last node in list */
  74         Boolean         isCirc;   /* true if the list should be considered
  75                                    * circular */
  76 /*
  77  * fields for sequential access
  78  */
  79         Where           atEnd;    /* Where in the list the last access was */
  80         Boolean         isOpen;   /* true if list has been Lst_Open'ed */
  81         ListNode        curPtr;   /* current node, if open. NilListNode if
  82                                    * *just* opened */
  83         ListNode        prevPtr;  /* Previous node, if open. Used by
  84                                    * Lst_Remove */
  85 } *List;
  86
  87 #define NilList         ((List)-1)
  88
  89 /*
  90  * PAlloc (var, ptype) --
  91  *      Allocate a pointer-typedef structure 'ptype' into the variable 'var'
  92  */
  93 #define PAlloc(var,ptype)       var = (ptype) emalloc (sizeof (*var))
  94
  95 /*
  96  * LstValid (l) --
  97  *      Return TRUE if the list l is valid
  98  */
  99 #define LstValid(l)     (((Lst)l == NILLST) ? FALSE : TRUE)
 100
 101 /*
 102  * LstNodeValid (ln, l) --
 103  *      Return TRUE if the LstNode ln is valid with respect to l
 104  */
 105 #define LstNodeValid(ln, l)     ((((LstNode)ln) == NILLNODE) ? FALSE : TRUE)
 106
 107 /*
 108  * LstIsEmpty (l) --
 109  *      TRUE if the list l is empty.
 110  */
 111 #define LstIsEmpty(l)   (((List)l)->firstPtr == NilListNode)
 112
 113 #endif /* _LSTINT_H_ */