Project

General

Profile

SO3Engine
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
SO3::SO3ScolFileSystemArchive Class Reference

#include <SO3ScolFileSystem.h>

Inheritance diagram for SO3::SO3ScolFileSystemArchive:

Public Member Functions

 SO3ScolFileSystemArchive (const Ogre::String &name, const Ogre::String &archType, bool readOnly)
 
 ~SO3ScolFileSystemArchive ()
 
virtual bool isCaseSensitive (void) const
 
bool isApk (void) const
 
virtual void load ()
 
virtual void unload ()
 
virtual Ogre::DataStreamPtr open (const Ogre::String &filename, bool readOnly=true) const
 
virtual Ogre::DataStreamPtr create (const Ogre::String &filename)
 
virtual void remove (const Ogre::String &filename)
 
virtual Ogre::StringVectorPtr list (bool recursive=true, bool dirs=false) const
 
virtual Ogre::FileInfoListPtr listFileInfo (bool recursive=true, bool dirs=false) const
 
virtual Ogre::StringVectorPtr find (const Ogre::String &pattern, bool recursive=true, bool dirs=false) const
 
virtual Ogre::FileInfoListPtr findFileInfo (const Ogre::String &pattern, bool recursive=true, bool dirs=false) const
 
virtual bool exists (const Ogre::String &filename) const
 
virtual time_t getModifiedTime (const Ogre::String &filename) const
 

Static Public Member Functions

static void setIgnoreHidden (bool ignore)
 
static bool getIgnoreHidden ()
 Get whether hidden files are ignored during filesystem enumeration.
 

Static Public Attributes

static bool msIgnoreHidden = true
 

Protected Member Functions

void findFiles (const Ogre::String &pattern, bool recursive, bool dirs, Ogre::StringVector *simpleList, Ogre::FileInfoList *detailList) const
 

Static Protected Member Functions

static bool is_reserved_dir (const char *fn)
 
static boost::filesystem::path concatenate_path (const Ogre::String base, const Ogre::String name)
 

Protected Attributes

 OGRE_AUTO_MUTEX
 
bool mApk
 
AAssetManager * mAssetManager
 
Ogre::String mPathPreFix
 

Detailed Description

Definition at line 37 of file SO3ScolFileSystem.h.

Constructor & Destructor Documentation

◆ SO3ScolFileSystemArchive()

SO3::SO3ScolFileSystemArchive::SO3ScolFileSystemArchive ( const Ogre::String &  name,
const Ogre::String &  archType,
bool  readOnly 
)

Definition at line 96 of file SO3ScolFileSystem.cpp.

◆ ~SO3ScolFileSystemArchive()

SO3::SO3ScolFileSystemArchive::~SO3ScolFileSystemArchive ( )

Definition at line 262 of file SO3ScolFileSystem.cpp.

Member Function Documentation

◆ concatenate_path()

boost::filesystem::path SO3::SO3ScolFileSystemArchive::concatenate_path ( const Ogre::String  base,
const Ogre::String  name 
)
staticprotected

Definition at line 162 of file SO3ScolFileSystem.cpp.

◆ create()

Ogre::DataStreamPtr SO3::SO3ScolFileSystemArchive::create ( const Ogre::String &  filename)
virtual

Construct return stream, tell it to delete on destroy

Definition at line 416 of file SO3ScolFileSystem.cpp.

◆ exists()

bool SO3::SO3ScolFileSystemArchive::exists ( const Ogre::String &  filename) const
virtual

Definition at line 685 of file SO3ScolFileSystem.cpp.

◆ find()

Ogre::StringVectorPtr SO3::SO3ScolFileSystemArchive::find ( const Ogre::String &  pattern,
bool  recursive = true,
bool  dirs = false 
) const
virtual

Definition at line 586 of file SO3ScolFileSystem.cpp.

◆ findFileInfo()

Ogre::FileInfoListPtr SO3::SO3ScolFileSystemArchive::findFileInfo ( const Ogre::String &  pattern,
bool  recursive = true,
bool  dirs = false 
) const
virtual

Definition at line 632 of file SO3ScolFileSystem.cpp.

◆ findFiles()

void SO3::SO3ScolFileSystemArchive::findFiles ( const Ogre::String &  pattern,
bool  recursive,
bool  dirs,
Ogre::StringVector *  simpleList,
Ogre::FileInfoList *  detailList 
) const
protected

Utility method to retrieve all files in a directory matching pattern.

Parameters
patternFile pattern.
recursiveWhether to cascade down directories.
dirsSet to true if you want the directories to be listed instead of files.
simpleListPopulated if retrieving a simple list.
detailListPopulated if retrieving a detailed list.

Definition at line 174 of file SO3ScolFileSystem.cpp.

◆ getIgnoreHidden()

static bool SO3::SO3ScolFileSystemArchive::getIgnoreHidden ( )
inlinestatic

Get whether hidden files are ignored during filesystem enumeration.

Definition at line 115 of file SO3ScolFileSystem.h.

◆ getModifiedTime()

time_t SO3::SO3ScolFileSystemArchive::getModifiedTime ( const Ogre::String &  filename) const
virtual

Definition at line 754 of file SO3ScolFileSystem.cpp.

◆ is_reserved_dir()

bool SO3::SO3ScolFileSystemArchive::is_reserved_dir ( const char *  fn)
staticprotected

Definition at line 156 of file SO3ScolFileSystem.cpp.

◆ isApk()

bool SO3::SO3ScolFileSystemArchive::isApk ( void  ) const

Definition at line 149 of file SO3ScolFileSystem.cpp.

◆ isCaseSensitive()

bool SO3::SO3ScolFileSystemArchive::isCaseSensitive ( void  ) const
virtual

Definition at line 138 of file SO3ScolFileSystem.cpp.

◆ list()

Ogre::StringVectorPtr SO3::SO3ScolFileSystemArchive::list ( bool  recursive = true,
bool  dirs = false 
) const
virtual

Definition at line 496 of file SO3ScolFileSystem.cpp.

◆ listFileInfo()

Ogre::FileInfoListPtr SO3::SO3ScolFileSystemArchive::listFileInfo ( bool  recursive = true,
bool  dirs = false 
) const
virtual

Definition at line 531 of file SO3ScolFileSystem.cpp.

◆ load()

void SO3::SO3ScolFileSystemArchive::load ( )
virtual

Definition at line 272 of file SO3ScolFileSystem.cpp.

◆ open()

Ogre::DataStreamPtr SO3::SO3ScolFileSystemArchive::open ( const Ogre::String &  filename,
bool  readOnly = true 
) const
virtual

Construct return stream, tell it to delete on destroy

Definition at line 284 of file SO3ScolFileSystem.cpp.

◆ remove()

void SO3::SO3ScolFileSystemArchive::remove ( const Ogre::String &  filename)
virtual

Definition at line 450 of file SO3ScolFileSystem.cpp.

◆ setIgnoreHidden()

static void SO3::SO3ScolFileSystemArchive::setIgnoreHidden ( bool  ignore)
inlinestatic

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 109 of file SO3ScolFileSystem.h.

◆ unload()

void SO3::SO3ScolFileSystemArchive::unload ( )
virtual

Definition at line 278 of file SO3ScolFileSystem.cpp.

Member Data Documentation

◆ mApk

bool SO3::SO3ScolFileSystemArchive::mApk
protected

Definition at line 59 of file SO3ScolFileSystem.h.

◆ mAssetManager

AAssetManager* SO3::SO3ScolFileSystemArchive::mAssetManager
protected

Definition at line 60 of file SO3ScolFileSystem.h.

◆ mPathPreFix

Ogre::String SO3::SO3ScolFileSystemArchive::mPathPreFix
protected

Definition at line 61 of file SO3ScolFileSystem.h.

◆ msIgnoreHidden

bool SO3::SO3ScolFileSystemArchive::msIgnoreHidden = true
static

Definition at line 120 of file SO3ScolFileSystem.h.

◆ OGRE_AUTO_MUTEX

SO3::SO3ScolFileSystemArchive::OGRE_AUTO_MUTEX
protected

Definition at line 57 of file SO3ScolFileSystem.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8