librevenge::RVNGInputStream Class Reference

#include <RVNGStream.h>

Inheritance diagram for librevenge::RVNGInputStream:
librevenge::RVNGDirectoryStream librevenge::RVNGFileStream librevenge::RVNGMemoryInputStream librevenge::RVNGStringStream

List of all members.

Public Member Functions

 RVNGInputStream ()
virtual ~RVNGInputStream ()
virtual bool isStructured ()=0
 Analyses the content of the input stream to see whether it is an OLE2 storage.
virtual unsigned subStreamCount ()=0
virtual const char * subStreamName (unsigned id)=0
virtual bool existsSubStream (const char *name)=0
virtual RVNGInputStreamgetSubStreamByName (const char *name)=0
 Extracts a named stream from an OLE2 storage.
virtual RVNGInputStreamgetSubStreamById (unsigned id)=0
virtual const unsigned char * read (unsigned long numBytes, unsigned long &numBytesRead)=0
 Tries to read a given number of bytes starting from the current position inside the input stream.
virtual int seek (long offset, RVNG_SEEK_TYPE seekType)=0
 Moves to the next location inside the input stream.
virtual long tell ()=0
 Returns the actual position inside the input stream.
virtual bool isEnd ()=0
 Determines whether the current position is at the end of the stream.

Constructor & Destructor Documentation

virtual librevenge::RVNGInputStream::~RVNGInputStream ( ) [inline, virtual]

Member Function Documentation

virtual RVNGInputStream* librevenge::RVNGInputStream::getSubStreamByName ( const char *  name) [pure virtual]

Extracts a named stream from an OLE2 storage.

Returns:
Should be a pointer to RVNGInputStream constructed from the named stream if it exists.
Should be 0, if the named stream does not exist inside the OLE2 storage or if the input stream is not an OLE2 storage.

Implemented in librevenge::RVNGDirectoryStream, librevenge::RVNGStringStream, librevenge::RVNGMemoryInputStream, and librevenge::RVNGFileStream.

virtual bool librevenge::RVNGInputStream::isEnd ( ) [pure virtual]

Determines whether the current position is at the end of the stream.

Returns:
A boolean value that should be true if the next location to be read in the input stream is beyond its end. In all other cases, it should be false.

Implemented in librevenge::RVNGDirectoryStream, librevenge::RVNGStringStream, librevenge::RVNGMemoryInputStream, and librevenge::RVNGFileStream.

virtual bool librevenge::RVNGInputStream::isStructured ( ) [pure virtual]

Analyses the content of the input stream to see whether it is an OLE2 storage.

Returns:
A boolean value that should be true if the input stream is an OLE2 storage and false if it is not the case

Implemented in librevenge::RVNGDirectoryStream, librevenge::RVNGStringStream, librevenge::RVNGFileStream, and librevenge::RVNGMemoryInputStream.

virtual const unsigned char* librevenge::RVNGInputStream::read ( unsigned long  numBytes,
unsigned long &  numBytesRead 
) [pure virtual]

Tries to read a given number of bytes starting from the current position inside the input stream.

Parameters:
numBytesNumber of bytes desired to be read.
numBytesReadNumber of bytes that were possible to be read.
Returns:
Should be a pointer to an array of numBytesRead bytes (unsigned char[numBytesRead]).
Optionally it could be 0 if the desired number of bytes could not be read.

Implemented in librevenge::RVNGDirectoryStream, librevenge::RVNGStringStream, librevenge::RVNGMemoryInputStream, and librevenge::RVNGFileStream.

Referenced by librevenge::RVNGZipStream::getSubstream().

virtual int librevenge::RVNGInputStream::seek ( long  offset,
RVNG_SEEK_TYPE  seekType 
) [pure virtual]

Moves to the next location inside the input stream.

Parameters:
offsetThe offset of the location inside the input stream to move to. It is relative either to the current position or to the beginning of the input stream depending on the value of the seekType parameter.
seekTypeDetermines whether the offset is relative to the beginning of the input stream (RVNG_SEEK_SET) or to the current position (RVNG_SEEK_CUR).
Returns:
An integer value that should be 0 (zero) if the seek was successful and any other value if it failed (i.e. the requested offset is beyond the end of the input stream or before its beginning).

Implemented in librevenge::RVNGDirectoryStream, librevenge::RVNGStringStream, librevenge::RVNGMemoryInputStream, and librevenge::RVNGFileStream.

Referenced by librevenge::getLength(), and librevenge::RVNGZipStream::isZipFile().

virtual long librevenge::RVNGInputStream::tell ( ) [pure virtual]

Returns the actual position inside the input stream.

Returns:
A long integer value that should correspond to the position of the next location to be read in the input stream.

Implemented in librevenge::RVNGDirectoryStream, librevenge::RVNGStringStream, librevenge::RVNGMemoryInputStream, and librevenge::RVNGFileStream.

Referenced by librevenge::getLength().


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