[BACK]Return to lst.h CVS log [TXT][DIR] Up to [local] / src / usr.bin / make

Annotation of src/usr.bin/make/lst.h, Revision 1.28

1.20      espie       1: #ifndef _LST_H_
                      2: #define _LST_H_
                      3:
1.19      espie       4: /*     $OpenPackages$ */
1.27      espie       5: /*     $OpenBSD$ */
1.19      espie       6: /*     $NetBSD: lst.h,v 1.7 1996/11/06 17:59:12 christos Exp $ */
1.1       deraadt     7:
                      8: /*
                      9:  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
                     10:  * Copyright (c) 1988, 1989 by Adam de Boor
                     11:  * Copyright (c) 1989 by Berkeley Softworks
                     12:  * All rights reserved.
                     13:  *
                     14:  * This code is derived from software contributed to Berkeley by
                     15:  * Adam de Boor.
                     16:  *
                     17:  * Redistribution and use in source and binary forms, with or without
                     18:  * modification, are permitted provided that the following conditions
                     19:  * are met:
                     20:  * 1. Redistributions of source code must retain the above copyright
                     21:  *    notice, this list of conditions and the following disclaimer.
                     22:  * 2. Redistributions in binary form must reproduce the above copyright
                     23:  *    notice, this list of conditions and the following disclaimer in the
                     24:  *    documentation and/or other materials provided with the distribution.
1.25      millert    25:  * 3. Neither the name of the University nor the names of its contributors
1.1       deraadt    26:  *    may be used to endorse or promote products derived from this software
                     27:  *    without specific prior written permission.
                     28:  *
                     29:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     30:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     31:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     32:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     33:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     34:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     35:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     36:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     37:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     38:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     39:  * SUCH DAMAGE.
                     40:  *
1.19      espie      41:  *     from: @(#)lst.h 8.1 (Berkeley) 6/6/93
1.1       deraadt    42:  */
                     43:
                     44: /*-
                     45:  * lst.h --
                     46:  *     Header for using the list library
                     47:  */
                     48:
1.14      espie      49: /* These data structures are PRIVATE !!!
                     50:  * Here for efficiency, so that some functions can be recoded as inlines,
                     51:  * and so that lst headers don't need dynamic allocation most of the time.  */
1.20      espie      52: struct ListNode_ {
1.19      espie      53:        struct ListNode_    *prevPtr;   /* previous element in list */
                     54:        struct ListNode_    *nextPtr;   /* next in list */
1.14      espie      55:        void                *datum;     /* datum associated with this element */
1.20      espie      56: };
1.14      espie      57:
1.20      espie      58: #ifndef LIST_TYPE
                     59: #include "lst_t.h"
                     60: #endif
1.1       deraadt    61:
1.19      espie      62: typedef void (*SimpleProc)(void *);
                     63: typedef int (*FindProc)(void *, void *);
1.26      espie      64: typedef int (*ForEachNodeWhileProc)(LstNode, void *);
1.19      espie      65: typedef int (*FindProcConst)(void *, const void *);
                     66: typedef void (*ForEachProc)(void *, void *);
                     67: typedef void *(*DuplicateProc)(void *);
1.1       deraadt    68:
                     69: /*
                     70:  * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
                     71:  *     not to be freed.
1.19      espie      72:  * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
1.1       deraadt    73:  */
1.19      espie      74: #define NOFREE         ((SimpleProc) 0)
                     75: #define NOCOPY         ((DuplicateProc) 0)
1.1       deraadt    76:
                     77: /*
1.19      espie      78:  * Creation/destruction functions
1.1       deraadt    79:  */
1.16      espie      80: /* Create a new list */
1.24      espie      81: #define Lst_Init(l)    (l)->firstPtr = (l)->lastPtr = NULL
                     82: /* Static lists are already okay */
                     83: #define Static_Lst_Init(l)
                     84:
1.19      espie      85: /* Duplicate an existing list */
                     86: extern Lst             Lst_Clone(Lst, Lst, DuplicateProc);
1.16      espie      87: /* Destroy an old one */
1.19      espie      88: extern void            Lst_Destroy(LIST *, SimpleProc);
1.1       deraadt    89: /* True if list is empty */
1.19      espie      90: #define        Lst_IsEmpty(l)  ((l)->firstPtr == NULL)
1.1       deraadt    91:
                     92: /*
1.19      espie      93:  * Functions to modify a list
1.1       deraadt    94:  */
                     95: /* Insert an element before another */
1.19      espie      96: extern void            Lst_Insert(Lst, LstNode, void *);
                     97: extern void            Lst_AtFront(Lst, void *);
1.1       deraadt    98: /* Insert an element after another */
1.19      espie      99: extern void            Lst_Append(Lst, LstNode, void *);
                    100: extern void            Lst_AtEnd(Lst, void *);
1.1       deraadt   101: /* Remove an element */
1.19      espie     102: extern void            Lst_Remove(Lst, LstNode);
1.1       deraadt   103: /* Replace a node with a new value */
1.19      espie     104: extern void            Lst_Replace(LstNode, void *);
                    105: /* Concatenate two lists, destructive. */
                    106: extern void            Lst_ConcatDestroy(Lst, Lst);
                    107: /* Concatenate two lists, non-destructive.  */
                    108: extern void            Lst_Concat(Lst, Lst);
1.27      espie     109: /* requeue element already in list at front of list */
                    110: extern void            Lst_Requeue(Lst, LstNode);
1.1       deraadt   111:
                    112: /*
1.19      espie     113:  * Node-specific functions
1.1       deraadt   114:  */
                    115: /* Return first element in list */
                    116: /* Return last element in list */
                    117: /* Return successor to given element */
1.19      espie     118: extern LstNode         Lst_Succ(LstNode);
1.1       deraadt   119:
                    120: /*
1.19      espie     121:  * Functions for entire lists
1.1       deraadt   122:  */
                    123: /* Find an element starting from somewhere */
1.19      espie     124: extern LstNode         Lst_FindFrom(LstNode, FindProc, void *);
1.1       deraadt   125: /*
1.19      espie     126:  * See if the given datum is on the list. Returns the LstNode containing
                    127:  * the datum
1.1       deraadt   128:  */
1.19      espie     129: extern LstNode         Lst_Member(Lst, void *);
                    130: /* Apply a function to elements of a lst starting from a certain point.  */
                    131: extern void            Lst_ForEachFrom(LstNode, ForEachProc, void *);
                    132: extern void            Lst_Every(Lst, SimpleProc);
1.26      espie     133:
                    134: extern void            Lst_ForEachNodeWhile(Lst, ForEachNodeWhileProc, void *);
1.1       deraadt   135:
1.20      espie     136: extern bool            Lst_AddNew(Lst, void *);
1.1       deraadt   137: /*
1.19      espie     138:  * for using the list as a queue
1.1       deraadt   139:  */
                    140: /* Place an element at tail of queue */
1.19      espie     141: #define Lst_EnQueue    Lst_AtEnd
                    142: #define Lst_QueueNew   Lst_AddNew
                    143:
1.20      espie     144: /*
                    145:  * for using the list as a stack
                    146:  */
                    147: #define Lst_Push       Lst_AtFront
                    148: #define Lst_Pop                Lst_DeQueue
                    149:
1.1       deraadt   150: /* Remove an element from head of queue */
1.19      espie     151: extern void *  Lst_DeQueue(Lst);
                    152:
                    153: #define Lst_Datum(ln)  ((ln)->datum)
                    154: #define Lst_First(l)   ((l)->firstPtr)
                    155: #define Lst_Last(l)    ((l)->lastPtr)
                    156: #define Lst_ForEach(l, proc, d) Lst_ForEachFrom(Lst_First(l), proc, d)
                    157: #define Lst_Find(l, cProc, d)  Lst_FindFrom(Lst_First(l), cProc, d)
                    158: #define Lst_Adv(ln)    ((ln)->nextPtr)
                    159: #define Lst_Rev(ln)    ((ln)->prevPtr)
                    160:
                    161:
1.20      espie     162: /* Inlines are preferable to macros here because of the type checking. */
1.19      espie     163: #ifdef HAS_INLINES
                    164: static INLINE LstNode
                    165: Lst_FindConst(Lst l, FindProcConst cProc, const void *d)
                    166: {
                    167:        return Lst_FindFrom(Lst_First(l), (FindProc)cProc, (void *)d);
                    168: }
                    169:
                    170: static INLINE LstNode
                    171: Lst_FindFromConst(LstNode ln, FindProcConst cProc, const void *d)
                    172: {
                    173:        return Lst_FindFrom(ln, (FindProc)cProc, (void *)d);
                    174: }
                    175: #else
                    176: #define Lst_FindConst(l, cProc, d) \
                    177:        Lst_FindFrom(Lst_First(l), (FindProc)cProc, (void *)d)
                    178: #define Lst_FindFromConst(ln, cProc, d) \
                    179:        Lst_FindFrom(ln, (FindProc)cProc, (void *)d)
                    180: #endif
1.1       deraadt   181:
                    182: #endif /* _LST_H_ */