#include <RVNGStreamImplementation.h>

Inheritance diagram for librevenge::RVNGFileStream:

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

Private Member Functions
	RVNGFileStream (const RVNGFileStream &)
RVNGFileStream &	operator= (const RVNGFileStream &)

Private Attributes
RVNGFileStreamPrivate *	d

Constructor & Destructor Documentation

◆ RVNGFileStream() [1/2]

librevenge::RVNGFileStream::RVNGFileStream ( const char * filename )

explicit

Referenced by operator=(), and RVNGFileStream().

◆ ~RVNGFileStream()

librevenge::RVNGFileStream::~RVNGFileStream ( )

◆ RVNGFileStream() [2/2]

librevenge::RVNGFileStream::RVNGFileStream ( const RVNGFileStream & )

private

Member Function Documentation

◆ existsSubStream()

bool librevenge::RVNGFileStream::existsSubStream ( const char * name )

virtual

Implements librevenge::RVNGInputStream.

◆ getSubStreamById()

RVNGInputStream * librevenge::RVNGFileStream::getSubStreamById ( unsigned id )

virtual

Implements librevenge::RVNGInputStream.

◆ getSubStreamByName()

RVNGInputStream * librevenge::RVNGFileStream::getSubStreamByName ( const char * name )

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.

Implements librevenge::RVNGInputStream.

Referenced by getSubStreamById().

◆ isEnd()

bool librevenge::RVNGFileStream::isEnd ( )

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.

Implements librevenge::RVNGInputStream.

◆ isStructured()

bool librevenge::RVNGFileStream::isStructured ( )

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

Implements librevenge::RVNGInputStream.

Referenced by existsSubStream(), getSubStreamByName(), subStreamCount(), and subStreamName().

◆ operator=()

RVNGFileStream & librevenge::RVNGFileStream::operator= ( const RVNGFileStream & )

private

◆ read()

const unsigned char * librevenge::RVNGFileStream::read	(	unsigned long	numBytes,
		unsigned long &	numBytesRead )

virtual

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

Parameters

numBytes	Number of bytes desired to be read.
numBytesRead	Number 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.

Implements librevenge::RVNGInputStream.

◆ seek()

int librevenge::RVNGFileStream::seek	(	long	offset,
		RVNG_SEEK_TYPE	seekType )

virtual

Moves to the next location inside the input stream.

Parameters

offset	The 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.
seekType	Determines 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).

Implements librevenge::RVNGInputStream.

Referenced by getSubStreamByName(), and isStructured().