contrib/bmake/lst.lib/lstRemove.c

   1 /*      $NetBSD: lstRemove.c,v 1.17 2020/07/03 08:37:57 rillig Exp $    */
   2
   3 /*
   4  * Copyright (c) 1988, 1989, 1990, 1993
   5  *      The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 #ifndef MAKE_NATIVE
  36 static char rcsid[] = "$NetBSD: lstRemove.c,v 1.17 2020/07/03 08:37:57 rillig Exp $";
  37 #else
  38 #include <sys/cdefs.h>
  39 #ifndef lint
  40 #if 0
  41 static char sccsid[] = "@(#)lstRemove.c 8.1 (Berkeley) 6/6/93";
  42 #else
  43 __RCSID("$NetBSD: lstRemove.c,v 1.17 2020/07/03 08:37:57 rillig Exp $");
  44 #endif
  45 #endif /* not lint */
  46 #endif
  47
  48 /*-
  49  * LstRemove.c --
  50  *      Remove an element from a list
  51  */
  52
  53 #include        "lstInt.h"
  54
  55 /*-
  56  *-----------------------------------------------------------------------
  57  * Lst_Remove --
  58  *      Remove the given node from the given list.
  59  *
  60  * Results:
  61  *      SUCCESS or FAILURE.
  62  *
  63  * Side Effects:
  64  *      The list's firstPtr will be set to NULL if ln is the last
  65  *      node on the list. firsPtr and lastPtr will be altered if ln is
  66  *      either the first or last node, respectively, on the list.
  67  *
  68  *-----------------------------------------------------------------------
  69  */
  70 ReturnStatus
  71 Lst_Remove(Lst l, LstNode ln)
  72 {
  73     List        list = l;
  74     ListNode    lNode = ln;
  75
  76     if (!LstValid (l) || !LstNodeValid (ln, l)) {
  77             return FAILURE;
  78     }
  79
  80     /*
  81      * unlink it from the list
  82      */
  83     if (lNode->nextPtr != NULL) {
  84         lNode->nextPtr->prevPtr = lNode->prevPtr;
  85     }
  86     if (lNode->prevPtr != NULL) {
  87         lNode->prevPtr->nextPtr = lNode->nextPtr;
  88     }
  89
  90     /*
  91      * if either the firstPtr or lastPtr of the list point to this node,
  92      * adjust them accordingly
  93      */
  94     if (list->firstPtr == lNode) {
  95         list->firstPtr = lNode->nextPtr;
  96     }
  97     if (list->lastPtr == lNode) {
  98         list->lastPtr = lNode->prevPtr;
  99     }
 100
 101     /*
 102      * Sequential access stuff. If the node we're removing is the current
 103      * node in the list, reset the current node to the previous one. If the
 104      * previous one was non-existent (prevPtr == NULL), we set the
 105      * end to be Unknown, since it is.
 106      */
 107     if (list->isOpen && (list->curPtr == lNode)) {
 108         list->curPtr = list->prevPtr;
 109         if (list->curPtr == NULL) {
 110             list->atEnd = Unknown;
 111         }
 112     }
 113
 114     /*
 115      * the only way firstPtr can still point to ln is if ln is the last
 116      * node on the list (the list is circular, so lNode->nextptr == lNode in
 117      * this case). The list is, therefore, empty and is marked as such
 118      */
 119     if (list->firstPtr == lNode) {
 120         list->firstPtr = NULL;
 121     }
 122
 123     /*
 124      * note that the datum is unmolested. The caller must free it as
 125      * necessary and as expected.
 126      */
 127     if (lNode->useCount == 0) {
 128         free(ln);
 129     } else {
 130         lNode->flags |= LN_DELETED;
 131     }
 132
 133     return SUCCESS;
 134 }