Archive-handling class. More...
#include <OgreArchive.h>
Public Member Functions | |
Archive (const String &name, const String &archType) | |
Constructor - don't call direct, used by ArchiveFactory. | |
virtual | ~Archive () |
Default destructor. | |
virtual DataStreamPtr | create (const String &filename) const |
Create a new file (or overwrite one already there). | |
virtual bool | exists (const String &filename)=0 |
Find out if the named file exists (note: fully qualified filename required) | |
virtual StringVectorPtr | find (const String &pattern, bool recursive=true, bool dirs=false)=0 |
Find all file or directory names matching a given pattern in this archive. | |
virtual FileInfoListPtr | findFileInfo (const String &pattern, bool recursive=true, bool dirs=false) const =0 |
Find all files or directories matching a given pattern in this archive and get some detailed information about them. | |
virtual time_t | getModifiedTime (const String &filename)=0 |
Retrieve the modification time of a given file. | |
const String & | getName (void) const |
Get the name of this archive. | |
const String & | getType (void) const |
Return the type code of this Archive. | |
virtual bool | isCaseSensitive (void) const =0 |
Returns whether this archive is case sensitive in the way it matches files. | |
virtual bool | isReadOnly () const |
Reports whether this Archive is read-only, or whether the contents can be updated. | |
virtual StringVectorPtr | list (bool recursive=true, bool dirs=false)=0 |
List all file names in the archive. | |
virtual FileInfoListPtr | listFileInfo (bool recursive=true, bool dirs=false)=0 |
List all files in the archive with accompanying information. | |
virtual void | load ()=0 |
Loads the archive. | |
virtual DataStreamPtr | open (const String &filename, bool readOnly=true) const =0 |
Open a stream on a given file. | |
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 | |
virtual void | remove (const String &filename) const |
Delete a named file. | |
virtual void | unload ()=0 |
Unloads the archive. | |
Protected Attributes | |
String | mName |
Archive name. | |
bool | mReadOnly |
Read-only flag. | |
String | mType |
Archive type code. | |
Archive-handling class.
Definition at line 88 of file OgreArchive.h.
Constructor - don't call direct, used by ArchiveFactory.
Definition at line 102 of file OgreArchive.h.
|
virtual |
Default destructor.
Definition at line 107 of file OgreArchive.h.
|
virtual |
Create a new file (or overwrite one already there).
filename | The fully qualified name of the file |
Reimplemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
Definition at line 155 of file OgreArchive.h.
References OGRE_EXCEPT.
Find out if the named file exists (note: fully qualified filename required)
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
|
pure 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 |
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
|
pure 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 |
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
Retrieve the modification time of a given file.
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
Get the name of this archive.
Definition at line 110 of file OgreArchive.h.
Return the type code of this Archive.
Definition at line 233 of file OgreArchive.h.
Returns whether this archive is case sensitive in the way it matches files.
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
Reports whether this Archive is read-only, or whether the contents can be updated.
Definition at line 134 of file OgreArchive.h.
|
pure 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 |
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
|
pure 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 |
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
Loads the archive.
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
|
pure 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) |
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
Delete a named file.
filename | The fully qualified name of the file |
Reimplemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
Definition at line 167 of file OgreArchive.h.
References OGRE_EXCEPT.
Unloads the archive.
Implemented in Ogre::APKFileSystemArchive, Ogre::FileSystemArchive, and Ogre::ZipArchive.
|
protected |
Archive name.
Definition at line 92 of file OgreArchive.h.
|
protected |
Read-only flag.
Definition at line 96 of file OgreArchive.h.
|
protected |
Archive type code.
Definition at line 94 of file OgreArchive.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.