workbench/libs/iffparse/collectionchunk.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #define DEBUG 0
   7 #include <aros/debug.h>
   8 #include "iffparse_intern.h"
   9
  10 /*****************************************************************************
  11
  12     NAME */
  13 #include <proto/iffparse.h>
  14
  15         AROS_LH3(LONG, CollectionChunk,
  16
  17 /*  SYNOPSIS */
  18         AROS_LHA(struct IFFHandle *, iff, A0),
  19         AROS_LHA(LONG              , type, D0),
  20         AROS_LHA(LONG              , id, D1),
  21
  22 /*  LOCATION */
  23         struct Library *, IFFParseBase, 23, IFFParse)
  24
  25 /*  FUNCTION
  26         Installs an entry handler with the given type and id, so that
  27         chunks encountered with the same type and id will be stored.
  28         This is quite like PropChunk(), but CollectionChunk() will
  29         store the contents of multiple chunks with the same type and id.
  30         To retrieve the stored collection of chunks one uses FindCollection().
  31         Remember: the collection is only valid inside the current property scope.
  32
  33     INPUTS
  34         iff   - Pointer to IFFHandle struct. (does not need to be open).
  35         type  - IFF chunk type declarator for chunk to collect.
  36         id    -  IFF chunk id identifier for chunk to collect.
  37
  38     RESULT
  39         error - 0 if successfulle. IFFERR_#? elsewise.
  40
  41     NOTES
  42
  43     EXAMPLE
  44
  45     BUGS
  46
  47     SEE ALSO
  48         CollectionChunks(), FindCollection(), PropChunk()
  49
  50     INTERNALS
  51
  52 *****************************************************************************/
  53 {
  54     AROS_LIBFUNC_INIT
  55
  56     DEBUG_COLLECTIONCHUNK(dprintf("CollectionChunk: iff 0x%lx type 0x%08lx (%c%c%c%c) id 0x%08lx (%c%c%c%c)\n",
  57                             iff, type, dmkid(type), id, dmkid(id)));
  58
  59     return
  60     (
  61         EntryHandler
  62         (
  63             iff,
  64             type,
  65             id,
  66             IFFSLI_TOP,
  67             &(IPB(IFFParseBase)->collectionhook),
  68             iff
  69         )
  70     );
  71
  72     AROS_LIBFUNC_EXIT
  73 } /* CollectionChunk */