usr.bin/make/lst.lib/lstIsAtEnd.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/lstIsAtEnd.c,v 1.5 1999/08/28 01:03:53 peter Exp $
  37  * $DragonFly: src/usr.bin/make/lst.lib/Attic/lstIsAtEnd.c,v 1.6 2004/12/16 23:24:10 okumoto Exp $
  38  *
  39  * @(#)lstIsAtEnd.c     8.1 (Berkeley) 6/6/93
  40  */
  41
  42 /*-
  43  * LstIsAtEnd.c --
  44  *      Tell if the current node is at the end of the list.
  45  *      The sequential functions access the list in a slightly different way.
  46  *      CurPtr points to their idea of the current node in the list and they
  47  *      access the list based on it. Lst_IsAtEnd must be used to determine
  48  *      when to stop.
  49  */
  50
  51 #include "make.h"
  52 #include "lst.h"
  53
  54 /*-
  55  *-----------------------------------------------------------------------
  56  * Lst_IsAtEnd --
  57  *      Return true if have reached the end of the given list.
  58  *
  59  * Results:
  60  *      TRUE if at the end of the list (this includes the list not being
  61  *      open or being invalid) or FALSE if not. We return TRUE if the list
  62  *      is invalid or unopend so as to cause the caller to exit its loop
  63  *      asap, the assumption being that the loop is of the form
  64  *          while (!Lst_IsAtEnd (l)) {
  65  *                ...
  66  *          }
  67  *
  68  * Side Effects:
  69  *      None.
  70  *
  71  *-----------------------------------------------------------------------
  72  */
  73 Boolean
  74 Lst_IsAtEnd(Lst list)
  75 {
  76
  77     return (!Lst_Valid(list) || !list->isOpen ||
  78             (list->atEnd == LstHead) || (list->atEnd == LstTail));
  79 }