workbench/libs/iffparse/currentchunk.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include "iffparse_intern.h"
   7
   8 /*****************************************************************************
   9
  10     NAME */
  11 #include <proto/iffparse.h>
  12
  13         AROS_LH1(struct ContextNode *, CurrentChunk,
  14
  15 /*  SYNOPSIS */
  16         AROS_LHA(struct IFFHandle *, iff, A0),
  17
  18 /*  LOCATION */
  19         struct Library *, IFFParseBase, 29, IFFParse)
  20
  21 /*  FUNCTION
  22         Returns the top context node for the give IFFHandle struct.
  23         The top contexte is the node most recently pushed onto the
  24         context stack
  25
  26     INPUTS
  27         iff  - pointer to IFFHandle struct.
  28
  29     RESULT
  30         top - Pointer to top contextnode or NULL if none.
  31
  32     NOTES
  33
  34     EXAMPLE
  35
  36     BUGS
  37
  38     SEE ALSO
  39         PushChunk(), PopChunk(), ParseIFF(), ParentChunk()
  40
  41     INTERNALS
  42         " .. or NULL if none" (see RESULT) is truth with slight modifications,
  43         since the default context node exists as long as the iffhandle
  44         itself. However, the user is never given a pointer to this node.
  45
  46 *****************************************************************************/
  47 {
  48     AROS_LIBFUNC_INIT
  49
  50     struct ContextNode *cn;
  51
  52     (void) IFFParseBase;
  53
  54     if (iff->iff_Depth)
  55         cn = TopChunk(iff);
  56     else
  57         /* If iffhandle is not opened yet, ther will be no contextnodes */
  58         cn = NULL;
  59
  60     return (cn);
  61
  62
  63     AROS_LIBFUNC_EXIT
  64 } /* CurrentChunk */