rom/exec/remove.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Remove a node from a list
   6     Lang: english
   7 */
   8
   9 #include <aros/debug.h>
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14 #include <exec/lists.h>
  15 #include <proto/exec.h>
  16
  17         AROS_LH1I(void, Remove,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct Node *, node, A1),
  21
  22 /*  LOCATION */
  23         struct ExecBase *, SysBase, 42, Exec)
  24
  25 /*  FUNCTION
  26         Remove a node from a list.
  27
  28     INPUTS
  29         node - This node to be removed.
  30
  31     RESULT
  32
  33     NOTES
  34         There is no need to specify the list but the node must be in
  35         a list !
  36
  37     EXAMPLE
  38         struct Node * node;
  39
  40         // Remove node
  41         Remove (node);
  42
  43     BUGS
  44
  45     SEE ALSO
  46
  47     INTERNALS
  48
  49 ******************************************************************************/
  50 {
  51     AROS_LIBFUNC_INIT
  52
  53     /*
  54         Unfortunately, there is no (quick) check that the node
  55         is in a list.
  56     */
  57     ASSERT(node != NULL);
  58
  59     /*
  60         Just bend the pointers around the node, ie. we make our
  61         predecessor point to our successor and vice versa
  62     */
  63     node->ln_Pred->ln_Succ = node->ln_Succ;
  64     node->ln_Succ->ln_Pred = node->ln_Pred;
  65
  66     AROS_LIBFUNC_EXIT
  67 } /* Remove */
  68