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.6 2004/12/10 19:22:25 okumoto 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 "make.h"
  48 #include "lst.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 NULL 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(Lst list, LstNode ln)
  67 {
  68
  69     if (!Lst_Valid(list) || !Lst_NodeValid(ln, list)) {
  70             return (FAILURE);
  71     }
  72
  73     /*
  74      * unlink it from the list
  75      */
  76     if (ln->nextPtr != NULL) {
  77         ln->nextPtr->prevPtr = ln->prevPtr;
  78     }
  79     if (ln->prevPtr != NULL) {
  80         ln->prevPtr->nextPtr = ln->nextPtr;
  81     }
  82
  83     /*
  84      * if either the firstPtr or lastPtr of the list point to this node,
  85      * adjust them accordingly
  86      */
  87     if (list->firstPtr == ln) {
  88         list->firstPtr = ln->nextPtr;
  89     }
  90     if (list->lastPtr == ln) {
  91         list->lastPtr = ln->prevPtr;
  92     }
  93
  94     /*
  95      * Sequential access stuff. If the node we're removing is the current
  96      * node in the list, reset the current node to the previous one. If the
  97      * previous one was non-existent (prevPtr == NULL), we set the
  98      * end to be Unknown, since it is.
  99      */
 100     if (list->isOpen && (list->curPtr == ln)) {
 101         list->curPtr = list->prevPtr;
 102         if (list->curPtr == NULL) {
 103             list->atEnd = LstUnknown;
 104         }
 105     }
 106
 107     /*
 108      * the only way firstPtr can still point to ln is if ln is the last
 109      * node on the list (the list is circular, so ln->nextptr == ln in
 110      * this case). The list is, therefore, empty and is marked as such
 111      */
 112     if (list->firstPtr == ln) {
 113         list->firstPtr = NULL;
 114     }
 115
 116     /*
 117      * note that the datum is unmolested. The caller must free it as
 118      * necessary and as expected.
 119      */
 120     if (ln->useCount == 0) {
 121         free(ln);
 122     } else {
 123         ln->flags |= LN_DELETED;
 124     }
 125
 126     return (SUCCESS);
 127 }