home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bsd / src / make / make-amiga / lst.h < prev    next >
C/C++ Source or Header  |  1993-09-23  |  5KB  |  143 lines
  1. /*
  2.  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
  3.  * Copyright (c) 1988, 1989 by Adam de Boor
  4.  * Copyright (c) 1989 by Berkeley Softworks
  5.  * All rights reserved.
  6.  *
  7.  * This code is derived from software contributed to Berkeley by
  8.  * Adam de Boor.
  9.  *
  10.  * Redistribution and use in source and binary forms, with or without
  11.  * modification, are permitted provided that the following conditions
  12.  * are met:
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  * 2. Redistributions in binary form must reproduce the above copyright
  16.  *    notice, this list of conditions and the following disclaimer in the
  17.  *    documentation and/or other materials provided with the distribution.
  18.  * 3. All advertising materials mentioning features or use of this software
  19.  *    must display the following acknowledgement:
  20.  *    This product includes software developed by the University of
  21.  *    California, Berkeley and its contributors.
  22.  * 4. Neither the name of the University nor the names of its contributors
  23.  *    may be used to endorse or promote products derived from this software
  24.  *    without specific prior written permission.
  25.  *
  26.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36.  * SUCH DAMAGE.
  37.  *
  38.  *    @(#)lst.h    5.3 (Berkeley) 6/1/90
  39.  */
  40.  
  41. /*-
  42.  * lst.h --
  43.  *    Header for using the list library
  44.  */
  45. #ifndef _LST_H_
  46. #define _LST_H_
  47.  
  48. #include    <sprite.h>
  49.  
  50. /*
  51.  * basic typedef. This is what the Lst_ functions handle
  52.  */
  53.  
  54. typedef    struct    Lst    *Lst;
  55. typedef    struct    LstNode    *LstNode;
  56.  
  57. #define    NILLST        ((Lst) NIL)
  58. #define    NILLNODE    ((LstNode) NIL)
  59.  
  60. /*
  61.  * NOFREE can be used as the freeProc to Lst_Destroy when the elements are
  62.  *    not to be freed.
  63.  * NOCOPY performs similarly when given as the copyProc to Lst_Duplicate.
  64.  */
  65. #define NOFREE        ((void (*)()) 0)
  66. #define NOCOPY        ((ClientData (*)()) 0)
  67.  
  68. #define LST_CONCNEW    0   /* create new LstNode's when using Lst_Concat */
  69. #define LST_CONCLINK    1   /* relink LstNode's when using Lst_Concat */
  70.  
  71. /*
  72.  * Creation/destruction functions
  73.  */
  74. Lst          Lst_Init();            /* Create a new list */
  75. Lst              Lst_Duplicate();      /* Duplicate an existing list */
  76. void          Lst_Destroy();    /* Destroy an old one */
  77.  
  78. int              Lst_Length();            /* Find the length of a list */
  79. Boolean          Lst_IsEmpty();    /* True if list is empty */
  80.  
  81. /*
  82.  * Functions to modify a list
  83.  */
  84. ReturnStatus      Lst_Insert();            /* Insert an element before another */
  85. ReturnStatus      Lst_Append();            /* Insert an element after another */
  86. ReturnStatus      Lst_AtFront();        /* Place an element at the front of
  87.                      * a lst. */
  88. ReturnStatus      Lst_AtEnd();            /* Place an element at the end of a
  89.                      * lst. */
  90. ReturnStatus      Lst_Remove();            /* Remove an element */
  91. ReturnStatus      Lst_Replace();    /* Replace a node with a new value */
  92. ReturnStatus      Lst_Move();            /* Move an element to another place */
  93. ReturnStatus      Lst_Concat();            /* Concatenate two lists */
  94.  
  95. /*
  96.  * Node-specific functions
  97.  */
  98. LstNode          Lst_First();            /* Return first element in list */
  99. LstNode          Lst_Last();            /* Return last element in list */
  100. LstNode          Lst_Succ();            /* Return successor to given element */
  101. LstNode          Lst_Pred();            /* Return predecessor to given
  102.                      * element */
  103. ClientData      Lst_Datum();            /* Get datum from LstNode */
  104.  
  105. /*
  106.  * Functions for entire lists
  107.  */
  108. LstNode          Lst_Find();            /* Find an element in a list */
  109. LstNode          Lst_FindFrom();    /* Find an element starting from
  110.                      * somewhere */
  111. LstNode              Lst_Member();            /* See if the given datum is on the
  112.                      * list. Returns the LstNode containing
  113.                      * the datum */
  114. int              Lst_Index();            /* Returns the index of a datum in the
  115.                      * list, starting from 0 */
  116. void          Lst_ForEach();    /* Apply a function to all elements of
  117.                      * a lst */
  118. void              Lst_ForEachFrom();      /* Apply a function to all elements of
  119.                      * a lst starting from a certain point.
  120.                      * If the list is circular, the
  121.                      * application will wrap around to the
  122.                      * beginning of the list again. */
  123. /*
  124.  * these functions are for dealing with a list as a table, of sorts.
  125.  * An idea of the "current element" is kept and used by all the functions
  126.  * between Lst_Open() and Lst_Close().
  127.  */
  128. ReturnStatus      Lst_Open();            /* Open the list */
  129. LstNode          Lst_Prev();            /* Previous element */
  130. LstNode          Lst_Cur();            /* The current element, please */
  131. LstNode          Lst_Next();            /* Next element please */
  132. Boolean          Lst_IsAtEnd();    /* Done yet? */
  133. void          Lst_Close();            /* Finish table access */
  134.  
  135. /*
  136.  * for using the list as a queue
  137.  */
  138. ReturnStatus      Lst_EnQueue();    /* Place an element at tail of queue */
  139. ClientData      Lst_DeQueue();    /* Remove an element from head of
  140.                      * queue */
  141.  
  142. #endif _LST_H_
  143.