Specialisation of the Archive class to allow reading of files from a zip format source archive. More...
#include <OgreZip.h>
Public Member Functions | |
ZipArchive (const String &name, const String &archType, zzip_plugin_io_handlers *pluginIo=NULL) | |
~ZipArchive () | |
DataStreamPtr | create (const String &filename) const |
Create a new file (or overwrite one already there). More... | |
bool | exists (const String &filename) |
Find out if the named file exists (note: fully qualified filename required) More... | |
StringVectorPtr | find (const String &pattern, bool recursive=true, bool dirs=false) |
Find all file or directory names matching a given pattern in this archive. More... | |
FileInfoListPtr | findFileInfo (const String &pattern, bool recursive=true, bool dirs=false) const |
Find all files or directories matching a given pattern in this archive and get some detailed information about them. More... | |
time_t | getModifiedTime (const String &filename) |
Retrieve the modification time of a given file. More... | |
const String & | getName (void) const |
Get the name of this archive. More... | |
const String & | getType (void) const |
Return the type code of this Archive. More... | |
bool | isCaseSensitive (void) const |
Returns whether this archive is case sensitive in the way it matches files. More... | |
virtual bool | isReadOnly () const |
Reports whether this Archive is read-only, or whether the contents can be updated. More... | |
StringVectorPtr | list (bool recursive=true, bool dirs=false) |
List all file names in the archive. More... | |
FileInfoListPtr | listFileInfo (bool recursive=true, bool dirs=false) |
List all files in the archive with accompanying information. More... | |
void | load () |
Loads the archive. More... | |
DataStreamPtr | open (const String &filename, bool readOnly=true) const |
Open a stream on a given file. 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) |
void | remove (const String &filename) const |
Delete a named file. More... | |
void | unload () |
Unloads the archive. More... | |
Protected Member Functions | |
void | checkZzipError (int zzipError, const String &operation) const |
Handle any errors from zzip. More... | |
Protected Attributes | |
FileInfoList | mFileList |
File list (since zziplib seems to only allow scanning of dir tree once) More... | |
String | mName |
Archive name. More... | |
zzip_plugin_io_handlers * | mPluginIo |
A pointer to file io alternative implementation. More... | |
bool | mReadOnly |
Read-only flag. More... | |
String | mType |
Archive type code. More... | |
ZZIP_DIR * | mZzipDir |
Handle to root zip file. More... | |
OGRE_AUTO_MUTEX | |
Specialisation of the Archive class to allow reading of files from a zip format source archive.
Ogre::ZipArchive::ZipArchive | ( | const String & | name, |
const String & | archType, | ||
zzip_plugin_io_handlers * | pluginIo = NULL |
||
) |
Ogre::ZipArchive::~ZipArchive | ( | ) |
|
protected |
Handle any errors from zzip.
|
virtual |
Create a new file (or overwrite one already there).
filename | The fully qualified name of the file |
Reimplemented from Ogre::Archive.
|
virtual |
Find out if the named file exists (note: fully qualified filename required)
Implements Ogre::Archive.
|
virtual |
Find all file or directory names matching a given pattern in this archive.
pattern | The pattern to search for; wildcards (*) are allowed |
recursive | Whether all paths of the archive are searched (if the archive has a concept of that) |
dirs | Set to true if you want the directories to be listed instead of files |
Implements Ogre::Archive.
|
virtual |
Find all files or directories matching a given pattern in this archive and get some detailed information about them.
pattern | The pattern to search for; wildcards (*) are allowed |
recursive | Whether all paths of the archive are searched (if the archive has a concept of that) |
dirs | Set to true if you want the directories to be listed instead of files |
Implements Ogre::Archive.
|
virtual |
Retrieve the modification time of a given file.
Implements Ogre::Archive.
|
inlineinherited |
Get the name of this archive.
Definition at line 110 of file OgreArchive.h.
|
inlineinherited |
Return the type code of this Archive.
Definition at line 233 of file OgreArchive.h.
|
inlinevirtual |
Returns whether this archive is case sensitive in the way it matches files.
Implements Ogre::Archive.
|
inlinevirtualinherited |
Reports whether this Archive is read-only, or whether the contents can be updated.
Definition at line 134 of file OgreArchive.h.
|
virtual |
List all file names in the archive.
recursive | Whether all paths of the archive are searched (if the archive has a concept of that) |
dirs | Set to true if you want the directories to be listed instead of files |
Implements Ogre::Archive.
|
virtual |
List all files in the archive with accompanying information.
recursive | Whether all paths of the archive are searched (if the archive has a concept of that) |
dirs | Set to true if you want the directories to be listed instead of files |
Implements Ogre::Archive.
|
virtual |
Loads the archive.
Implements Ogre::Archive.
|
virtual |
Open a stream on a given file.
filename | The fully qualified name of the file |
readOnly | Whether to open the file in read-only mode or not (note, if the archive is read-only then this cannot be set to false) |
Implements Ogre::Archive.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
virtual |
Delete a named file.
filename | The fully qualified name of the file |
Reimplemented from Ogre::Archive.
|
virtual |
Unloads the archive.
Implements Ogre::Archive.
|
protected |
|
protectedinherited |
Archive name.
Definition at line 92 of file OgreArchive.h.
|
protected |
|
protectedinherited |
Read-only flag.
Definition at line 96 of file OgreArchive.h.
|
protectedinherited |
Archive type code.
Definition at line 94 of file OgreArchive.h.
|
protected |