ScummVM API documentation
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Common::IFFParser Class Reference
Common API » Interchange File Format (IFF)

#include <iff_container.h>

Inheritance diagram for Common::IFFParser:
Kyra::IFFParser Toon::IFFParser

Public Types

typedef Functor1< IFFChunk &, bool > IFFCallback
 

Public Member Functions

 IFFParser (ReadStream *stream, bool disposeStream=false, IFF_ID formHeaderID=MKTAG('F', 'O', 'R', 'M'))
 
void parse (IFFCallback &callback)
 

Protected Member Functions

void setInputStream (ReadStream *stream)
 

Protected Attributes

IFFChunkNav _formChunk
 The root chunk of the file.
 
IFFChunkNav _chunk
 The current chunk.
 
uint32 _formSize
 
IFF_ID _formType
 
IFF_ID _formHeaderID
 
ReadStream * _stream
 
bool _disposeStream
 

Detailed Description

Parser for IFF containers.

Member Typedef Documentation

◆ IFFCallback

typedef Functor1< IFFChunk&, bool > Common::IFFParser::IFFCallback

Callback type for the parser.

Member Function Documentation

◆ parse()

void Common::IFFParser::parse ( IFFCallback &  callback)

Parse the IFF container, invoking the callback on each chunk encountered. The callback can interrupt the parsing by returning 'true'.

The documentation for this class was generated from the following file: