![]() |
OGRE 2.1
Object-Oriented Graphics Rendering Engine
|
Specialisation of DataStream to handle streaming data from zip archives. More...
#include <OgreZip.h>
Public Types | |
enum | AccessMode { READ = 1 , WRITE = 2 } |
Public Member Functions | |
ZipDataStream (const String &name, ZZIP_FILE *zzipFile, size_t uncompressedSize) | |
Constructor for creating named streams. | |
ZipDataStream (ZZIP_FILE *zzipFile, size_t uncompressedSize) | |
Unnamed constructor. | |
~ZipDataStream () | |
void | close (void) |
Close the stream; this makes further operations invalid. | |
bool | eof (void) const |
Returns true if the stream has reached the end. | |
uint16 | getAccessMode () const |
Gets the access mode of the stream. | |
virtual String | getAsString (void) |
Returns a String containing the entire stream. | |
virtual String | getLine (bool trimAfter=true) |
Returns a String containing the next line of data, optionally trimmed for whitespace. | |
const String & | getName (void) |
Returns the name of the stream, if it has one. | |
virtual bool | isReadable () const |
Reports whether this stream is readable. | |
virtual bool | isWriteable () const |
Reports whether this stream is writeable. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
template<typename T > | |
DataStream & | operator>> (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. | |
virtual size_t | readLine (char *buf, size_t maxCount, const String &delim="\n") |
Get a single line from the stream. | |
void | seek (size_t pos) |
Repositions the read point to a specified byte. | |
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 | skip (long count) |
Skip a defined number of bytes. | |
virtual size_t | skipLine (const String &delim="\n") |
Skip a single line from the stream. | |
size_t | tell (void) const |
Repositions the read point to a specified byte. | |
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) | |
Specialisation of DataStream to handle streaming data from zip archives.
|
inherited |
Unnamed constructor.
Ogre::ZipDataStream::ZipDataStream | ( | const String & | name, |
ZZIP_FILE * | zzipFile, | ||
size_t | uncompressedSize | ||
) |
Constructor for creating named streams.
Ogre::ZipDataStream::~ZipDataStream | ( | ) |
Close the stream; this makes further operations invalid.
Implements Ogre::DataStream.
Returns true if the stream has reached the end.
Implements Ogre::DataStream.
|
inlineinherited |
Gets the access mode of the stream.
Returns a String containing the entire stream.
Returns a String containing the next line of data, optionally trimmed for whitespace.
trimAfter | If true, the line is trimmed for whitespace (as in String.trim(true,true)) |
Returns the name of the stream, if it has one.
Reports whether this stream is readable.
Reports whether this stream is writeable.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
inherited |
Read the requisite number of bytes from the stream, stopping at the end of the file.
buf | Reference to a buffer pointer |
count | Number of bytes to read |
Implements Ogre::DataStream.
|
virtualinherited |
Get a single line from the stream.
buf | Reference to a buffer pointer |
maxCount | The maximum length of data to be read, excluding the terminating character |
delim | The delimiter to stop at |
Reimplemented in Ogre::MemoryDataStream, and Ogre::FileStreamDataStream.
Repositions the read point to a specified byte.
Implements Ogre::DataStream.
Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.
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.
Skip a single line from the stream.
delim | The delimiter(s) to stop at |
Reimplemented in Ogre::MemoryDataStream.
Repositions the read point to a specified byte.
Implements Ogre::DataStream.
Write the requisite number of bytes from the stream (only applicable to streams that are not read-only)
buf | Pointer to a buffer containing the bytes to write |
count | Number of bytes to write |
Reimplemented from Ogre::DataStream.