usr.bin/make/lst.lib/lstOpen.c

   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  * $FreeBSD: src/usr.bin/make/lst.lib/lstOpen.c,v 1.5 1999/08/28 01:03:56 peter Exp $
  37  * $DragonFly: src/usr.bin/make/lst.lib/Attic/lstOpen.c,v 1.7 2004/12/16 23:24:10 okumoto Exp $
  38  *
  39  * @(#)lstOpen.c        8.1 (Berkeley) 6/6/93
  40  */
  41
  42 /*-
  43  * LstOpen.c --
  44  *      Open a list for sequential access. The sequential functions access the
  45  *      list in a slightly different way. CurPtr points to their idea of the
  46  *      current node in the list and they access the list based on it.
  47  *      Lst_IsAtEnd must be used to determine when to stop.
  48  */
  49
  50 #include "make.h"
  51 #include "lst.h"
  52
  53 /*-
  54  *-----------------------------------------------------------------------
  55  * Lst_Open --
  56  *      Open a list for sequential access. A list can still be searched,
  57  *      etc., without confusing these functions.
  58  *
  59  * Results:
  60  *      SUCCESS or FAILURE.
  61  *
  62  * Side Effects:
  63  *      isOpen is set TRUE and curPtr is set to NULL so the
  64  *      other sequential functions no it was just opened and can choose
  65  *      the first element accessed based on this.
  66  *
  67  *-----------------------------------------------------------------------
  68  */
  69 ReturnStatus
  70 Lst_Open(Lst l)
  71 {
  72
  73         if (Lst_Valid(l) == FALSE) {
  74                 return (FAILURE);
  75         }
  76         l->isOpen = TRUE;
  77         l->atEnd = Lst_IsEmpty(l) ? LstHead : LstUnknown;
  78         l->curPtr = NULL;
  79
  80         return (SUCCESS);
  81 }