usr.bin/make/lst.lib/lstRemove.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/lstRemove.c,v 1.6 1999/08/28 01:03:56 peter Exp $
  37  */
  38
  39 #ifndef lint
  40 static char sccsid[] = "@(#)lstRemove.c 8.1 (Berkeley) 6/6/93";
  41 #endif /* not lint */
  42
  43 /*-
  44  * LstRemove.c --
  45  *      Remove an element from a list
  46  */
  47
  48 #include        "lstInt.h"
  49
  50 /*-
  51  *-----------------------------------------------------------------------
  52  * Lst_Remove --
  53  *      Remove the given node from the given list.
  54  *
  55  * Results:
  56  *      SUCCESS or FAILURE.
  57  *
  58  * Side Effects:
  59  *      The list's firstPtr will be set to NilListNode if ln is the last
  60  *      node on the list. firsPtr and lastPtr will be altered if ln is
  61  *      either the first or last node, respectively, on the list.
  62  *
  63  *-----------------------------------------------------------------------
  64  */
  65 ReturnStatus
  66 Lst_Remove (l, ln)
  67     Lst                 l;
  68     LstNode             ln;
  69 {
  70     register List       list = (List) l;
  71     register ListNode   lNode = (ListNode) ln;
  72
  73     if (!LstValid (l) ||
  74         !LstNodeValid (ln, l)) {
  75             return (FAILURE);
  76     }
  77
  78     /*
  79      * unlink it from the list
  80      */
  81     if (lNode->nextPtr != NilListNode) {
  82         lNode->nextPtr->prevPtr = lNode->prevPtr;
  83     }
  84     if (lNode->prevPtr != NilListNode) {
  85         lNode->prevPtr->nextPtr = lNode->nextPtr;
  86     }
  87
  88     /*
  89      * if either the firstPtr or lastPtr of the list point to this node,
  90      * adjust them accordingly
  91      */
  92     if (list->firstPtr == lNode) {
  93         list->firstPtr = lNode->nextPtr;
  94     }
  95     if (list->lastPtr == lNode) {
  96         list->lastPtr = lNode->prevPtr;
  97     }
  98
  99     /*
 100      * Sequential access stuff. If the node we're removing is the current
 101      * node in the list, reset the current node to the previous one. If the
 102      * previous one was non-existent (prevPtr == NilListNode), we set the
 103      * end to be Unknown, since it is.
 104      */
 105     if (list->isOpen && (list->curPtr == lNode)) {
 106         list->curPtr = list->prevPtr;
 107         if (list->curPtr == NilListNode) {
 108             list->atEnd = Unknown;
 109         }
 110     }
 111
 112     /*
 113      * the only way firstPtr can still point to ln is if ln is the last
 114      * node on the list (the list is circular, so lNode->nextptr == lNode in
 115      * this case). The list is, therefore, empty and is marked as such
 116      */
 117     if (list->firstPtr == lNode) {
 118         list->firstPtr = NilListNode;
 119     }
 120
 121     /*
 122      * note that the datum is unmolested. The caller must free it as
 123      * necessary and as expected.
 124      */
 125     if (lNode->useCount == 0) {
 126         free ((Address)ln);
 127     } else {
 128         lNode->flags |= LN_DELETED;
 129     }
 130
 131     return (SUCCESS);
 132 }
 133