Ogre::DeflateStream Class Reference

Stream which compresses / uncompresses data using the 'deflate' compression algorithm. More...

#include <OgreDeflate.h>

Inheritance diagram for Ogre::DeflateStream:

Public Types
enum	AccessMode { READ = 1, WRITE = 2 }
Public Member Functions
	DeflateStream (const DataStreamPtr &compressedStream, const String &tmpFileName="")
	Constructor for creating unnamed stream wrapping another stream.
	DeflateStream (const String &name, const DataStreamPtr &compressedStream, const String &tmpFileName="")
	Constructor for creating named stream wrapping another stream.
	~DeflateStream ()
bool	isCompressedStreamValid () const
	Returns whether the compressed stream is valid deflated data.
size_t	read (void *buf, size_t count)
size_t	write (const void *buf, size_t count)
void	skip (long count)
void	seek (size_t pos)
size_t	tell (void) const
bool	eof (void) const
void	close (void)
const String &	getName (void)
	Returns the name of the stream, if it has one.
uint16	getAccessMode () const
	Gets the access mode of the stream.
virtual bool	isReadable () const
	Reports whether this stream is readable.
virtual bool	isWriteable () const
	Reports whether this stream is writeable.
template<typename T >
DataStream &	operator>> (T &val)
virtual size_t	readLine (char *buf, size_t maxCount, const String &delim="\n")
	Get a single line from the stream.
virtual String	getLine (bool trimAfter=true)
	Returns a String containing the next line of data, optionally trimmed for whitespace.
virtual String	getAsString (void)
	Returns a String containing the entire stream.
virtual size_t	skipLine (const String &delim="\n")
	Skip a single line from the stream.
size_t	size (void) const
	Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
Protected Member Functions
void	init ()
void	destroy ()
void	compressFinal ()
Protected Attributes
DataStreamPtr	mCompressedStream
DataStreamPtr	mTmpWriteStream
String	mTempFileName
z_stream *	mZStream
size_t	mCurrentPos
StaticCache < 16 *OGRE_STREAM_TEMP_SIZE >	mReadCache
	Cache for read data in case skipping around.
unsigned char *	mTmp
	Intermediate buffer for read / write.
bool	mIsCompressedValid
	Whether the underlying stream is valid compressed data.
String	mName
	The name (e.g. resource name) that can be used to identify the source fot his data (optional).
size_t	mSize
	Size of the data in the stream (may be 0 if size cannot be determined).
uint16	mAccess
	What type of access is allowed (AccessMode).

Detailed Description

Stream which compresses / uncompresses data using the 'deflate' compression algorithm.

Remarks:: This stream is designed to wrap another stream for the actual source / destination of the compressed data, it has no concrete source / data itself. The idea is that you pass uncompressed data through this stream, and the underlying stream reads/writes compressed data to the final source.

Note:: This is an alternative to using a compressed archive since it is able to compress & decompress regardless of the actual source of the stream. You should avoid using this with already compressed archives. Also note that this cannot be used as a read / write stream, only a read-only or write-only stream.

Definition at line 55 of file OgreDeflate.h.

Member Enumeration Documentation

enum Ogre::DataStream::AccessMode [inherited]

Enumerator:

READ
WRITE

Definition at line 178 of file OgreDataStream.h.

Constructor & Destructor Documentation

Ogre::DeflateStream::DeflateStream	(	const DataStreamPtr &	compressedStream,
		const String &	tmpFileName = `""`
	)

Constructor for creating unnamed stream wrapping another stream.

Parameters:

	compressedStream	The stream that this stream will use when reading / writing compressed data. The access mode from this stream will be matched.
	tmpFileName	Path/Filename to be used for temporary storage of incoming data

Ogre::DeflateStream::DeflateStream	(	const String &	name,
		const DataStreamPtr &	compressedStream,
		const String &	tmpFileName = `""`
	)

Constructor for creating named stream wrapping another stream.

Parameters:

	name	The name to give this stream
	compressedStream	The stream that this stream will use when reading / writing compressed data. The access mode from this stream will be matched.
	tmpFileName	Path/Filename to be used for temporary storage of incoming data

Ogre::DeflateStream::~DeflateStream ( )

Member Function Documentation

void Ogre::DeflateStream::close ( void ) [virtual]

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

void Ogre::DeflateStream::compressFinal ( ) [protected]

void Ogre::DeflateStream::destroy ( ) [protected]

bool Ogre::DeflateStream::eof ( void ) const [virtual]

Returns true if the stream has reached the end.

Implements Ogre::DataStream.

uint16 Ogre::DataStream::getAccessMode ( ) const [inherited]

Gets the access mode of the stream.

Definition at line 201 of file OgreDataStream.h.

virtual String Ogre::DataStream::getAsString ( void ) [virtual, inherited]

Returns a String containing the entire stream.

Remarks:: This is a convenience method for text streams only, allowing you to retrieve a String object containing all the data in the stream.

virtual String Ogre::DataStream::getLine ( bool trimAfter = true ) [virtual, inherited]

Returns a String containing the next line of data, optionally trimmed for whitespace.

Remarks:: This is a convenience method for text streams only, allowing you to retrieve a String object containing the next line of data. The data is read up to the next newline character and the result trimmed if required.

Note:: If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.

Parameters:

trimAfter

If true, the line is trimmed for whitespace (as in String.trim(true,true))

const String& Ogre::DataStream::getName ( void ) [inherited]

Returns the name of the stream, if it has one.

Definition at line 199 of file OgreDataStream.h.

void Ogre::DeflateStream::init ( ) [protected]

bool Ogre::DeflateStream::isCompressedStreamValid ( ) const

Returns whether the compressed stream is valid deflated data.

Remarks:: If you pass this class a READ stream which is not compressed with the deflate algorithm, this method returns false and all read commands will actually be executed as passthroughs as a fallback.

Definition at line 100 of file OgreDeflate.h.

virtual bool Ogre::DataStream::isReadable ( ) const [virtual, inherited]

Reports whether this stream is readable.

Definition at line 203 of file OgreDataStream.h.

virtual bool Ogre::DataStream::isWriteable ( ) const [virtual, inherited]

Reports whether this stream is writeable.

Definition at line 205 of file OgreDataStream.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 90 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<typename T >

DataStream& Ogre::DataStream::operator>> ( T & val ) [inherited]

size_t Ogre::DeflateStream::read	(	void *	buf,
		size_t	count
	)			`[virtual]`

Read the requisite number of bytes from the stream, stopping at the end of the file.

Parameters:

	buf	Reference to a buffer pointer
	count	Number of bytes to read

Returns:: The number of bytes read

Implements Ogre::DataStream.

virtual size_t Ogre::DataStream::readLine	(	char *	buf,
		size_t	maxCount,
		const String &	delim = `"\n"`
	)			`[virtual, inherited]`

Get a single line from the stream.

Remarks:: The delimiter character is not included in the data returned, and it is skipped over so the next read will occur after it. The buffer contents will include a terminating character.