File: [local] / src / usr.bin / make / lst.h (download)
Revision 1.17, Fri Jun 23 16:15:49 2000 UTC (23 years, 11 months ago) by espie
Branch: MAIN
Changes since 1.16: +7 -5 lines
Trivial consequences of the previous list changes:
- audit code for Lst_Datum, it's never applied to an empty pointer,
so check can be removed -> turn into a macro,
- Lst_First, Lst_Last can become macro as well
- specialized version of Lst_Succ (Lst_Adv) to use in loops where it cannot
fail,
- Lst_Open can no longer fail. Trim down corresponding code.
Reviewed millert@, miod@
|
/* $OpenBSD: lst.h,v 1.17 2000/06/23 16:15:49 espie Exp $ */
/* $NetBSD: lst.h,v 1.7 1996/11/06 17:59:12 christos Exp $ */
/*
* Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
* Copyright (c) 1988, 1989 by Adam de Boor
* Copyright (c) 1989 by Berkeley Softworks
* All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* from: @(#)lst.h 8.1 (Berkeley) 6/6/93
*/
/*-
* lst.h --
* Header for using the list library
*/
#ifndef _LST_H_
#define _LST_H_
#include "sprite.h"
#include <sys/param.h>
#ifdef __STDC__
#include <stdlib.h>
#endif
/* These data structures are PRIVATE !!!
* Here for efficiency, so that some functions can be recoded as inlines,
* and so that lst headers don't need dynamic allocation most of the time. */
typedef struct ListNode_ {
struct ListNode_ *prevPtr; /* previous element in list */
struct ListNode_ *nextPtr; /* next in list */
short useCount:8, /* Count of functions using the node.
* node may not be deleted until count
* goes to 0 */
flags:8; /* Node status flags */
void *datum; /* datum associated with this element */
} *LstNode;
typedef enum {
Head, Middle, Tail, Unknown
} Where;
typedef struct {
LstNode firstPtr; /* first node in list */
LstNode lastPtr; /* last node in list */
/*
* fields for sequential access
*/
Where atEnd; /* Where in the list the last access was */
Boolean isOpen; /* true if list has been Lst_Open'ed */
LstNode curPtr; /* current node, if open. NULL if
* *just* opened */
LstNode prevPtr; /* Previous node, if open. Used by
* Lst_Remove */
} LIST;
typedef LIST *Lst;
/*
* basic typedef. This is what the Lst_ functions handle
*/
typedef int (*FindProc) __P((void *, void *));
typedef void (*SimpleProc) __P((void *));
typedef void (*ForEachProc) __P((void *, void *));
typedef void * (*DuplicateProc) __P((void *));
/*
* NOFREE can be used as the freeProc to Lst_Destroy when the elements are
* not to be freed.
* NOCOPY performs similarly when given as the copyProc to Lst_Clone.
*/
#define NOFREE ((SimpleProc)0)
#define NOCOPY ((DuplicateProc)0)
/*
* Creation/destruction functions
*/
/* CTOR/DTOR, ala C++ */
/* Create a new list */
void Lst_Init __P((Lst));
/* Destroy an old one */
void Lst_Destroy __P((Lst, SimpleProc));
/* Duplicate an existing list */
Lst Lst_Clone __P((Lst, Lst, DuplicateProc));
/* True if list is empty */
Boolean Lst_IsEmpty __P((Lst));
/*
* Functions to modify a list
*/
/* Insert an element before another */
void Lst_Insert __P((Lst, LstNode, void *));
/* Insert an element after another */
void Lst_Append __P((Lst, LstNode, void *));
/* Place an element at the front of a lst. */
void Lst_AtFront __P((Lst, void *));
/* Place an element at the end of a lst. */
void Lst_AtEnd __P((Lst, void *));
/* Remove an element */
void Lst_Remove __P((Lst, LstNode));
/* Replace a node with a new value */
void Lst_Replace __P((LstNode, void *));
/* Concatenate two lists, destructive. */
void Lst_ConcatDestroy __P((Lst, Lst));
/* Concatenate two lists, non destructive */
void Lst_Concat __P((Lst, Lst));
/*
* Node-specific functions
*/
/* Return first element in list */
#define Lst_First(l) ((l)->firstPtr)
/* Return last element in list */
#define Lst_Last(l) ((l)->lastPtr)
/* Return successor to given element */
LstNode Lst_Succ __P((LstNode));
/* Return successor to existing element */
#define Lst_Adv(ln) ((ln)->nextPtr)
/* Get datum from LstNode */
#define Lst_Datum(ln) ((ln)->datum)
/*
* Functions for entire lists
*/
/* Find an element in a list */
#define Lst_Find(l, cProc, d) Lst_FindFrom(Lst_First(l), cProc, d)
/* Find an element starting from somewhere */
LstNode Lst_FindFrom __P((LstNode, FindProc, void *));
/* Apply a function to all elements of a lst */
#define Lst_ForEach(l, proc, d) Lst_ForEachFrom(Lst_First(l), proc, d)
/* Apply a function to all elements of a lst starting from a certain point. */
void Lst_ForEachFrom __P((LstNode, ForEachProc, void *));
void Lst_Every __P((Lst, SimpleProc));
/*
* See if the given datum is on the list. Returns the LstNode containing
* the datum
*/
LstNode Lst_Member __P((Lst, void *));
/*
* these functions are for dealing with a list as a table, of sorts.
* An idea of the "current element" is kept and used by all the functions
* between Lst_Open() and Lst_Close().
*/
/* Open the list */
void Lst_Open __P((Lst));
/* Next element please */
LstNode Lst_Next __P((Lst));
/* Done yet? */
Boolean Lst_IsAtEnd __P((Lst));
/* Finish table access */
void Lst_Close __P((Lst));
/*
* for using the list as a queue
*/
/* Place an element at tail of queue */
void Lst_EnQueue __P((Lst, void *));
/* Remove an element from head of queue */
void * Lst_DeQueue __P((Lst));
#endif /* _LST_H_ */