workbench/libs/iffparse/parentchunk.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 *, ParentChunk,
  14
  15 /*  SYNOPSIS */
  16         AROS_LHA(struct ContextNode *, contextNode, A0),
  17
  18 /*  LOCATION */
  19         struct Library *, IFFParseBase, 30, IFFParse)
  20
  21 /*  FUNCTION
  22         Returns a pointer to the parent context node to the given
  23         one on the context node stack. The parent context node
  24         represents the chunk enclosing the chunk given.
  25         This can be use together with CurrentChunk() to iterate the
  26         context node stack top-down.
  27
  28     INPUTS
  29         contextNode  - pointer to a context node.
  30
  31     RESULT
  32         parent      -  pointer to the parent context node or NULL if none.
  33
  34     NOTES
  35
  36     EXAMPLE
  37
  38     BUGS
  39
  40     SEE ALSO
  41         CurrentChunk()
  42
  43     INTERNALS
  44
  45 *****************************************************************************/
  46 {
  47     AROS_LIBFUNC_INIT
  48
  49     struct ContextNode *parentcn;
  50
  51     (void) IFFParseBase;
  52
  53     /* Get the parent of this contextnode. The contextstack
  54       is simulated via AddHead/RemHead so we should use
  55       .mln_Succ to get the parent
  56     */
  57     parentcn = (struct ContextNode*)contextNode->cn_Node.mln_Succ;
  58
  59     /* If the parent of the found node is 0 (mlh_Tail field
  60        in struct MinList, then parentcn is the default contextnode,
  61        which the user not should have access to
  62     */
  63
  64     if (!parentcn->cn_Node.mln_Succ)
  65         parentcn = NULL;
  66
  67     return (parentcn);
  68
  69     AROS_LIBFUNC_EXIT
  70 } /* ParentChunk */