workbench/libs/iffparse/closeiff.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(void, CloseIFF,
  14
  15 /*  SYNOPSIS */
  16         AROS_LHA(struct IFFHandle *, iff, A0),
  17
  18 /*  LOCATION */
  19         struct Library *, IFFParseBase, 8, IFFParse)
  20
  21 /*  FUNCTION
  22         Completes a read or write session by closing the IFF handle.
  23         The IFFHandle struct is ready for reuse in another session,
  24         it's just to open it again with OpenIFF(). This function
  25         also automatically cleans up if a read or write fails halfway through.
  26
  27     INPUTS
  28         iff - Pointer to an IFFhandle struct previously opened with OpenIFF()
  29
  30     RESULT
  31
  32     NOTES
  33         This function tells the custom stream handler to clean up
  34         by sending it a IFFCMD_CLEANUP IFFStreamCmd.
  35
  36     EXAMPLE
  37
  38     BUGS
  39
  40     SEE ALSO
  41         OpenIFF(), InitIFF()
  42
  43     INTERNALS
  44         This function checks that buffers for buffered streams
  45         have been freed. This is not very elegant and should have been
  46         done at an earlier stadium. It is not a real bug though.
  47
  48 *****************************************************************************/
  49 {
  50     AROS_LIBFUNC_INIT
  51
  52     struct IFFStreamCmd    cmd;
  53
  54     if (iff != NULL)
  55     {
  56         /* clear the IFFF_OPEN bit to mark IFF stream closed */
  57         if (!(iff->iff_Flags & IFFF_OPEN) )
  58         {
  59             return;
  60         }
  61
  62         iff->iff_Flags &= ~IFFF_OPEN;
  63
  64         /* Pop of all contextnodes so that only the default one is remaining */
  65
  66         /*
  67         for (count = iff->iff_Depth; count; count -- )
  68         {
  69             PopContextNode(iff, IPB(IFFParseBase));
  70         }
  71         */
  72         while (iff->iff_Depth)
  73         {
  74             PopChunk(iff);
  75         }
  76
  77         /* This is for safety:
  78           It might be in PopChunk that seeking or writing to streams failed.
  79           In that case the memory for eventual buffered setreams
  80           were not freed, so we should free it here.
  81
  82           (Yes, it is is a kludge !)
  83         */
  84         if ( GetIntIH(iff)->iff_BufferStartDepth)
  85         {
  86             FreeBuffer((struct BufferList*)iff->iff_Stream, IPB(IFFParseBase));
  87
  88             GetIntIH(iff)->iff_BufferStartDepth = 0;
  89         }
  90
  91         /* Tell the custom stream to cleanup */
  92         cmd.sc_Command = IFFCMD_CLEANUP;
  93         CallHookPkt
  94         (
  95             GetIntIH(iff)->iff_StreamHandler,
  96             iff,
  97             &cmd
  98         );
  99     }
 100
 101     AROS_LIBFUNC_EXIT
 102 } /* CloseIFF */