File: [local] / src / usr.bin / make / lst.h (download)
Revision 1.12, Sat Jun 10 01:32:23 2000 UTC (23 years, 11 months ago) by espie
Branch: MAIN
Changes since 1.11: +18 -17 lines
Thus, Lst_ForEach no longer needs returning a status.
In fact, it can become a macro based on Lst_ForEachFrom.
This also introduces Lst_Every, as a shortcut for the very common case where
Lst_ForEach does not need any user data.
Finally, make consistent use of a few function typedefs, instead of having
explicit void (*)(Lst) arguments all over the place.
|
/* $OpenBSD: lst.h,v 1.12 2000/06/10 01:32:23 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
/*
* basic typedef. This is what the Lst_ functions handle
*/
typedef struct Lst *Lst;
typedef struct LstNode *LstNode;
typedef int (*FindProc) __P((ClientData, ClientData));
typedef void (*SimpleProc) __P((ClientData));
typedef void (*ForEachProc) __P((ClientData, ClientData));
typedef ClientData (*DuplicateProc) __P((ClientData));
/*
* 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_Duplicate.
*/
#define NOFREE ((SimpleProc)0)
#define NOCOPY ((DuplicateProc)0)
#define LST_CONCNEW 0 /* create new LstNode's when using Lst_Concat */
#define LST_CONCLINK 1 /* relink LstNode's when using Lst_Concat */
/*
* Creation/destruction functions
*/
/* Create a new list */
Lst Lst_Init __P((void));
/* Duplicate an existing list */
Lst Lst_Duplicate __P((Lst, DuplicateProc));
/* Destroy an old one */
void Lst_Destroy __P((Lst, SimpleProc));
/* 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, ClientData));
/* Insert an element after another */
void Lst_Append __P((Lst, LstNode, ClientData));
/* Place an element at the front of a lst. */
void Lst_AtFront __P((Lst, ClientData));
/* Place an element at the end of a lst. */
void Lst_AtEnd __P((Lst, ClientData));
/* Remove an element */
void Lst_Remove __P((Lst, LstNode));
/* Replace a node with a new value */
void Lst_Replace __P((LstNode, ClientData));
/* Concatenate two lists */
void Lst_Concat __P((Lst, Lst, int));
/*
* Node-specific functions
*/
/* Return first element in list */
LstNode Lst_First __P((Lst));
/* Return last element in list */
LstNode Lst_Last __P((Lst));
/* Return successor to given element */
LstNode Lst_Succ __P((LstNode));
/* Get datum from LstNode */
ClientData Lst_Datum __P((LstNode));
/*
* 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, ClientData));
/* 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, ClientData));
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, ClientData));
/*
* 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 */
ReturnStatus 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, ClientData));
/* Remove an element from head of queue */
ClientData Lst_DeQueue __P((Lst));
#endif /* _LST_H_ */