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