OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::ZipDataStream Class Reference

Specialisation of DataStream to handle streaming data from zip archives. More...

#include <OgreZip.h>

+ Inheritance diagram for Ogre::ZipDataStream:
+ Collaboration diagram for Ogre::ZipDataStream:

Public Types

enum  AccessMode { READ = 1, WRITE = 2 }
 

Public Member Functions

 ZipDataStream (ZZIP_FILE *zzipFile, size_t uncompressedSize)
 Unnamed constructor. More...
 
 ZipDataStream (const String &name, ZZIP_FILE *zzipFile, size_t uncompressedSize)
 Constructor for creating named streams. More...
 
 ~ZipDataStream ()
 
void close (void)
 Close the stream; this makes further operations invalid. More...
 
bool eof (void) const
 Returns true if the stream has reached the end. More...
 
uint16 getAccessMode () const
 Gets the access mode of the stream. More...
 
virtual String getAsString (void)
 Returns a String containing the entire stream. More...
 
virtual String getLine (bool trimAfter=true)
 Returns a String containing the next line of data, optionally trimmed for whitespace. More...
 
const StringgetName (void)
 Returns the name of the stream, if it has one. More...
 
virtual bool isReadable () const
 Reports whether this stream is readable. More...
 
virtual bool isWriteable () const
 Reports whether this stream is writeable. More...
 
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 *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
template<typename T >
DataStreamoperator>> (T &val)
 
size_t read (void *buf, size_t count)
 Read the requisite number of bytes from the stream, stopping at the end of the file. More...
 
virtual size_t readLine (char *buf, size_t maxCount, const String &delim="\n")
 Get a single line from the stream. More...
 
void seek (size_t pos)
 Repositions the read point to a specified byte. More...
 
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. More...
 
void skip (long count)
 Skip a defined number of bytes. More...
 
virtual size_t skipLine (const String &delim="\n")
 Skip a single line from the stream. More...
 
size_t tell (void) const
 Repositions the read point to a specified byte. More...
 
size_t write (void *buf, size_t count)
 Write the requisite number of bytes from the stream (only applicable to streams that are not read-only) More...
 
virtual size_t write (const void *buf, size_t count)
 Write the requisite number of bytes from the stream (only applicable to streams that are not read-only) More...
 

Protected Attributes

uint16 mAccess
 What type of access is allowed (AccessMode) More...
 
StaticCache
< 2 *OGRE_STREAM_TEMP_SIZE
mCache
 We need caching because sometimes serializers step back in data stream and zziplib behaves slow. More...
 
String mName
 The name (e.g. resource name) that can be used to identify the source for this data (optional) More...
 
size_t mSize
 Size of the data in the stream (may be 0 if size cannot be determined) More...
 
ZZIP_FILEmZzipFile
 

Detailed Description

Specialisation of DataStream to handle streaming data from zip archives.

Definition at line 165 of file OgreZip.h.

Member Enumeration Documentation

Enumerator
READ 
WRITE 

Definition at line 181 of file OgreDataStream.h.

Constructor & Destructor Documentation

Ogre::ZipDataStream::ZipDataStream ( ZZIP_FILE zzipFile,
size_t  uncompressedSize 
)

Unnamed constructor.

Ogre::ZipDataStream::ZipDataStream ( const String name,
ZZIP_FILE zzipFile,
size_t  uncompressedSize 
)

Constructor for creating named streams.

Ogre::ZipDataStream::~ZipDataStream ( )

Member Function Documentation

void Ogre::ZipDataStream::close ( void  )
virtual

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

bool Ogre::ZipDataStream::eof ( void  ) const
virtual

Returns true if the stream has reached the end.

Implements Ogre::DataStream.

uint16 Ogre::DataStream::getAccessMode ( ) const
inlineinherited

Gets the access mode of the stream.

Definition at line 204 of file OgreDataStream.h.

virtual String Ogre::DataStream::getAsString ( void  )
virtualinherited

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)
virtualinherited

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
trimAfterIf true, the line is trimmed for whitespace (as in String.trim(true,true))
const String& Ogre::DataStream::getName ( void  )
inlineinherited

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

Definition at line 202 of file OgreDataStream.h.

virtual bool Ogre::DataStream::isReadable ( ) const
inlinevirtualinherited

Reports whether this stream is readable.

Definition at line 206 of file OgreDataStream.h.

virtual bool Ogre::DataStream::isWriteable ( ) const
inlinevirtualinherited

Reports whether this stream is writeable.

Definition at line 208 of file OgreDataStream.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

template<typename T >
DataStream& Ogre::DataStream::operator>> ( T &  val)
inherited
size_t Ogre::ZipDataStream::read ( void *  buf,
size_t  count 
)
virtual

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

Parameters
bufReference to a buffer pointer
countNumber 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" 
)
virtualinherited

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.
Note
If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.
Parameters
bufReference to a buffer pointer
maxCountThe maximum length of data to be read, excluding the terminating character
delimThe delimiter to stop at
Returns
The number of bytes read, excluding the terminating character

Reimplemented in Ogre::FileStreamDataStream, and Ogre::MemoryDataStream.

void Ogre::ZipDataStream::seek ( size_t  pos)
virtual

Repositions the read point to a specified byte.

Implements Ogre::DataStream.

size_t Ogre::DataStream::size ( void  ) const
inlineinherited

Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.

Definition at line 299 of file OgreDataStream.h.

void Ogre::ZipDataStream::skip ( long  count)
virtual

Skip a defined number of bytes.

This can also be a negative value, in which case the file pointer rewinds a defined number of bytes.

Implements Ogre::DataStream.

virtual size_t Ogre::DataStream::skipLine ( const String delim = "\n")
virtualinherited

Skip a single line from the stream.

Note
If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.
Parameters
delimThe delimiter(s) to stop at
Returns
The number of bytes skipped

Reimplemented in Ogre::MemoryDataStream.

size_t Ogre::ZipDataStream::tell ( void  ) const
virtual

Repositions the read point to a specified byte.

Implements Ogre::DataStream.

size_t Ogre::ZipDataStream::write ( void *  buf,
size_t  count 
)

Write the requisite number of bytes from the stream (only applicable to streams that are not read-only)

Parameters
bufPointer to a buffer containing the bytes to write
countNumber of bytes to write
Returns
The number of bytes written
virtual size_t Ogre::DataStream::write ( const void *  buf,
size_t  count 
)
inlinevirtualinherited

Write the requisite number of bytes from the stream (only applicable to streams that are not read-only)

Parameters
bufPointer to a buffer containing the bytes to write
countNumber of bytes to write
Returns
The number of bytes written

Reimplemented in Ogre::FileHandleDataStream, Ogre::FileStreamDataStream, Ogre::MemoryDataStream, and Ogre::DeflateStream.

Definition at line 225 of file OgreDataStream.h.

Member Data Documentation

uint16 Ogre::DataStream::mAccess
protectedinherited

What type of access is allowed (AccessMode)

Definition at line 192 of file OgreDataStream.h.

StaticCache<2 * OGRE_STREAM_TEMP_SIZE> Ogre::ZipDataStream::mCache
protected

We need caching because sometimes serializers step back in data stream and zziplib behaves slow.

Definition at line 170 of file OgreZip.h.

String Ogre::DataStream::mName
protectedinherited

The name (e.g. resource name) that can be used to identify the source for this data (optional)

Definition at line 188 of file OgreDataStream.h.

size_t Ogre::DataStream::mSize
protectedinherited

Size of the data in the stream (may be 0 if size cannot be determined)

Definition at line 190 of file OgreDataStream.h.

ZZIP_FILE* Ogre::ZipDataStream::mZzipFile
protected

Definition at line 168 of file OgreZip.h.


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