Specialisation of the Archive class to allow reading of files from filesystem folders / directories. More...
#include <OgreFileSystem.h>
Public Member Functions | |
FileSystemArchive (const String &name, const String &archType, bool readOnly) | |
~FileSystemArchive () | |
DataStreamPtr | create (const String &filename) const |
Create a new file (or overwrite one already there). | |
bool | exists (const String &filename) |
Find out if the named file exists (note: fully qualified filename required) | |
StringVectorPtr | find (const String &pattern, bool recursive=true, bool dirs=false) |
Find all file or directory names matching a given pattern in this archive. | |
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. | |
time_t | getModifiedTime (const String &filename) |
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. | |
bool | isCaseSensitive (void) const |
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. | |
StringVectorPtr | list (bool recursive=true, bool dirs=false) |
List all file names in the archive. | |
FileInfoListPtr | listFileInfo (bool recursive=true, bool dirs=false) |
List all files in the archive with accompanying information. | |
void | load () |
Loads the archive. | |
DataStreamPtr | open (const String &filename, bool readOnly=true) const |
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 | |
void | remove (const String &filename) const |
Delete a named file. | |
void | unload () |
Unloads the archive. | |
Static Public Member Functions | |
static bool | getIgnoreHidden () |
Get whether hidden files are ignored during filesystem enumeration. | |
static void | setIgnoreHidden (bool ignore) |
Set whether filesystem enumeration will include hidden files or not. | |
Static Public Attributes | |
static bool | msIgnoreHidden |
Protected Member Functions | |
void | findFiles (const String &pattern, bool recursive, bool dirs, StringVector *simpleList, FileInfoList *detailList) const |
Utility method to retrieve all files in a directory matching pattern. | |
Protected Attributes | |
String | mName |
Archive name. | |
bool | mReadOnly |
Read-only flag. | |
String | mType |
Archive type code. | |
OGRE_AUTO_MUTEX | |
Specialisation of the Archive class to allow reading of files from filesystem folders / directories.
Definition at line 49 of file OgreFileSystem.h.
Ogre::FileSystemArchive::FileSystemArchive | ( | const String & | name, |
const String & | archType, | ||
bool | readOnly | ||
) |
Ogre::FileSystemArchive::~FileSystemArchive | ( | ) |
|
virtual |
Create a new file (or overwrite one already there).
filename | The fully qualified name of the file |
Reimplemented from Ogre::Archive.
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.
|
protected |
Utility method to retrieve all files in a directory matching pattern.
pattern | File pattern. |
recursive | Whether to cascade down directories. |
dirs | Set to true if you want the directories to be listed instead of files. |
simpleList | Populated if retrieving a simple list. |
detailList | Populated if retrieving a detailed list. |
Get whether hidden files are ignored during filesystem enumeration.
Definition at line 118 of file OgreFileSystem.h.
Retrieve the modification time of a given file.
Implements Ogre::Archive.
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.
Implements Ogre::Archive.
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.
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 from Ogre::Archive.
Set whether filesystem enumeration will include hidden files or not.
This should be called prior to declaring and/or initializing filesystem resource locations. The default is true (ignore hidden files).
Definition at line 112 of file OgreFileSystem.h.
|
virtual |
Unloads the archive.
Implements Ogre::Archive.
|
protectedinherited |
Archive name.
Definition at line 92 of file OgreArchive.h.
|
protectedinherited |
Read-only flag.
Definition at line 96 of file OgreArchive.h.
|
static |
Definition at line 123 of file OgreFileSystem.h.
|
protectedinherited |
Archive type code.
Definition at line 94 of file OgreArchive.h.
|
protected |
Definition at line 67 of file OgreFileSystem.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.