RIFF Namespace Reference

RIFF specific classes and definitions. More...


Classes

class  Chunk
 Provides convenient methods to access data of RIFF chunks in general. More...
class  List
 Provides convenient methods to access data of RIFF list chunks and their subchunks. More...
class  File
 Parses arbitrary RIFF files and provides together with it's base classes convenient methods to walk through the RIFF tree. More...
class  Exception
 Will be thrown whenever an error occurs while parsing a RIFF file. More...

Typedefs

typedef std::string String

Enumerations

enum  stream_mode_t { stream_mode_read = 0, stream_mode_read_write = 1, stream_mode_closed = 2 }
 Whether file stream is open in read or in read/write mode. More...
enum  stream_state_t { stream_ready = 0, stream_end_reached = 1, stream_closed = 2 }
 Current state of the file stream. More...
enum  stream_whence_t { stream_start = 0, stream_curpos = 1, stream_backward = 2, stream_end = 3 }
 File stream position dependent to these relations. More...

Functions

String libraryName ()
 Returns the name of this C++ library.
String libraryVersion ()
 Returns version of this C++ library.
String __resolveChunkPath (Chunk *pCk)
 Returns a human readable path of the given chunk.


Detailed Description

RIFF specific classes and definitions.

Typedef Documentation

typedef std::string RIFF::String

Definition at line 91 of file RIFF.h.


Enumeration Type Documentation

enum RIFF::stream_mode_t

Whether file stream is open in read or in read/write mode.

Enumerator:
stream_mode_read 
stream_mode_read_write 
stream_mode_closed 

Definition at line 96 of file RIFF.h.

enum RIFF::stream_state_t

Current state of the file stream.

Enumerator:
stream_ready 
stream_end_reached 
stream_closed 

Definition at line 103 of file RIFF.h.

enum RIFF::stream_whence_t

File stream position dependent to these relations.

Enumerator:
stream_start 
stream_curpos 
stream_backward 
stream_end 

Definition at line 110 of file RIFF.h.


Function Documentation

String RIFF::__resolveChunkPath ( Chunk *  pCk  ) 

Returns a human readable path of the given chunk.

Definition at line 36 of file RIFF.cpp.

References CHUNK_ID_LIST, RIFF::List::GetListTypeString(), and RIFF::Chunk::GetParent().

Referenced by RIFF::Chunk::Resize(), and RIFF::File::Save().

String RIFF::libraryName (  ) 

Returns the name of this C++ library.

This is usually "libgig" of course. This call is equivalent to DLS::libraryName() and gig::libraryName().

Definition at line 1769 of file RIFF.cpp.

String RIFF::libraryVersion (  ) 

Returns version of this C++ library.

This call is equivalent to DLS::libraryVersion() and gig::libraryVersion().

Definition at line 1777 of file RIFF.cpp.


Generated on Thu Aug 16 06:40:58 2007 for libgig by  doxygen 1.5.3