rom/utility/nexttagitem.c

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3     $Id$    $Log
   4 */
   5
   6 #include <proto/arossupport.h>
   7
   8 #include "intern.h"
   9
  10 /*****************************************************************************
  11
  12     NAME */
  13 #include <utility/tagitem.h>
  14 #include <proto/utility.h>
  15
  16         AROS_LH1I(struct TagItem *, NextTagItem,
  17
  18 /*  SYNOPSIS */
  19         AROS_LHA(struct TagItem **, tagListPtr, A0),
  20
  21 /*  LOCATION */
  22         struct Library *, UtilityBase, 8, Utility)
  23
  24 /*  FUNCTION
  25         Returns the address of the next tag-item in the list. This
  26         routine correctly handles TAG_END, TAG_DONE, TAG_MORE,
  27         TAG_IGNORE and TAG_SKIP.
  28
  29         TAG_END and TAG_DONE both terminate a TagItems-array (in
  30         fact, TAG_DONE is the same as TAG_END).
  31
  32         With TAG_MORE, you can redirect the processing to a new list
  33         of tags. Note that the processing will not return to the previous
  34         list when a TAG_END/TAG_DONE is encountered.
  35
  36         TAG_IGNORE disables the processing of an entry in the list.
  37         This entry is just ignored (We use this technique for filtering).
  38
  39         TAG_SKIP skips this tagitem, and the next number of tagitems as
  40         indicated in the tag's ti_Data field.
  41
  42     INPUTS
  43         tagListPtr - Pointer to an element in a taglist.
  44
  45     RESULT
  46         Next tag item or NULL if you reached the end of the list.
  47
  48     NOTES
  49         - TAG_MORE works like "go on with new list" instead of "read new
  50           list and go on with the current one".
  51
  52     EXAMPLE
  53
  54     BUGS
  55
  56     SEE ALSO
  57
  58     INTERNALS
  59
  60 *****************************************************************************/
  61 {
  62     AROS_LIBFUNC_INIT
  63
  64 /*  Gosh, can't enable these because we get LOTS of hits at startup time
  65  *
  66  *  ASSERT_VALID_PTR(tagListPtr);
  67  *  ASSERT_VALID_PTR(*tagListPtr);
  68  */
  69
  70     /* Use code from libarossupport */
  71     return LibNextTagItem(tagListPtr);
  72
  73     AROS_LIBFUNC_EXIT
  74 } /* NextTagItem */