rom/exec/remtail.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Remove the last node of 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(struct Node *, RemTail,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct List *, list, A0),
  21
  22 /*  LOCATION */
  23         struct ExecBase *, SysBase, 44, Exec)
  24
  25 /*  FUNCTION
  26         Remove the last node from a list.
  27
  28     INPUTS
  29         list - Remove the node from this list
  30
  31     RESULT
  32         The node that has been removed.
  33
  34     NOTES
  35
  36     EXAMPLE
  37         struct List * list;
  38         struct Node * tail;
  39
  40         // Remove node and return it
  41         tail = RemTail (list);
  42
  43     BUGS
  44
  45     SEE ALSO
  46
  47     INTERNALS
  48
  49 ******************************************************************************/
  50 {
  51     AROS_LIBFUNC_INIT
  52     struct Node * node;
  53
  54     /*
  55         Unfortunately, there is no (quick) check that the node
  56         is in a list.
  57     */
  58     ASSERT(list != NULL);
  59
  60     /* Get the last node of the list */
  61     if ( (node = GetTail (list)) )
  62     {
  63         /* normal code to remove a node if there is one */
  64         node->ln_Pred->ln_Succ = node->ln_Succ;
  65         node->ln_Succ->ln_Pred = node->ln_Pred;
  66     }
  67
  68     /* return it's address or NULL if there was no node */
  69     return node;
  70     AROS_LIBFUNC_EXIT
  71 } /* RemTail */
  72