OgreAPKFileSystemArchive.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 
29 #ifndef __APKFileSystemArchive_H__
30 #define __APKFileSystemArchive_H__
31 
32 #include <OgreArchive.h>
33 #include <OgreArchiveFactory.h>
34 #include <android/asset_manager.h>
35 
36 namespace Ogre{
38  {
39  private:
40  AAssetManager* mAssetMgr;
42 
43  public:
44  APKFileSystemArchive(const String& name, const String& archType, AAssetManager* assetMgr);
46 
48  bool isCaseSensitive(void) const;
49 
51  void load();
53  void unload();
54 
56  DataStreamPtr open(const String& filename, bool readOnly = true) const;
57 
59  DataStreamPtr create(const String& filename) const;
60 
62  void remove(const String& filename) const;
63 
65  StringVectorPtr list(bool recursive = true, bool dirs = false);
66 
68  FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false);
69 
71  StringVectorPtr find(const String& pattern, bool recursive = true, bool dirs = false);
72 
74  FileInfoListPtr findFileInfo(const String& pattern, bool recursive = true, bool dirs = false) const;
75 
77  bool exists(const String& filename);
78 
80  time_t getModifiedTime(const String& filename);
81  };
82 
84  {
85  public:
86  APKFileSystemArchiveFactory(AAssetManager* assetMgr) : mAssetMgr(assetMgr) {}
89  const String& getType(void) const;
91  Archive *createInstance( const String& name, bool readOnly )
92  {
94  }
96  void destroyInstance( Archive* arch) { OGRE_DELETE arch; }
97  private:
98  AAssetManager* mAssetMgr;
99  };
100 }
101 
102 #endif
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::APKFileSystemArchive::list
StringVectorPtr list(bool recursive=true, bool dirs=false)
List all file names in the archive.
Ogre::APKFileSystemArchive::remove
void remove(const String &filename) const
Ogre::APKFileSystemArchiveFactory::~APKFileSystemArchiveFactory
virtual ~APKFileSystemArchiveFactory()
Definition: OgreAPKFileSystemArchive.h:87
OGRE_DELETE
#define OGRE_DELETE
Definition: OgreMemoryAllocatorConfig.h:474
Ogre::APKFileSystemArchive::exists
bool exists(const String &filename)
Find out if the named file exists (note: fully qualified filename required)
Ogre::APKFileSystemArchive::open
DataStreamPtr open(const String &filename, bool readOnly=true) const
Open a stream on a given file.
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::ArchiveFactory
Abstract factory class, archive codec plugins can register concrete subclasses of this.
Definition: OgreArchiveFactory.h:59
Ogre::APKFileSystemArchive::find
StringVectorPtr find(const String &pattern, bool recursive=true, bool dirs=false)
Find all file or directory names matching a given pattern in this archive.
Ogre::APKFileSystemArchive::~APKFileSystemArchive
~APKFileSystemArchive()
Ogre::APKFileSystemArchive::create
DataStreamPtr create(const String &filename) const
Create a new file (or overwrite one already there).
Ogre::APKFileSystemArchiveFactory::createInstance
Archive * createInstance(const String &name, bool readOnly)
Creates a new object.
Definition: OgreAPKFileSystemArchive.h:91
OgreArchiveFactory.h
Ogre::APKFileSystemArchive::mAssetMgr
AAssetManager * mAssetMgr
Definition: OgreAPKFileSystemArchive.h:40
Ogre::APKFileSystemArchive::unload
void unload()
Unloads the archive.
Ogre::APKFileSystemArchive::listFileInfo
FileInfoListPtr listFileInfo(bool recursive=true, bool dirs=false)
List all files in the archive with accompanying information.
Ogre::APKFileSystemArchive::APKFileSystemArchive
APKFileSystemArchive(const String &name, const String &archType, AAssetManager *assetMgr)
Ogre::APKFileSystemArchiveFactory::mAssetMgr
AAssetManager * mAssetMgr
Definition: OgreAPKFileSystemArchive.h:98
Ogre::APKFileSystemArchive
Definition: OgreAPKFileSystemArchive.h:37
Ogre::SharedPtr< DataStream >
Ogre::APKFileSystemArchiveFactory
Definition: OgreAPKFileSystemArchive.h:83
Ogre::APKFileSystemArchive::mPathPreFix
String mPathPreFix
Definition: OgreAPKFileSystemArchive.h:41
Ogre::APKFileSystemArchive::isCaseSensitive
bool isCaseSensitive(void) const
Returns whether this archive is case sensitive in the way it matches files.
Ogre::Archive
Archive-handling class.
Definition: OgreArchive.h:88
OGRE_NEW
#define OGRE_NEW
Definition: OgreMemoryAllocatorConfig.h:473
Ogre::APKFileSystemArchive::getModifiedTime
time_t getModifiedTime(const String &filename)
Retrieve the modification time of a given file.
Ogre::APKFileSystemArchiveFactory::getType
const String & getType(void) const
Returns the factory type.
Ogre::APKFileSystemArchive::load
void load()
Loads the archive.
Ogre::APKFileSystemArchiveFactory::APKFileSystemArchiveFactory
APKFileSystemArchiveFactory(AAssetManager *assetMgr)
Definition: OgreAPKFileSystemArchive.h:86
Ogre::APKFileSystemArchiveFactory::destroyInstance
void destroyInstance(Archive *arch)
Destroys an object which was created by this factory.
Definition: OgreAPKFileSystemArchive.h:96
Ogre::APKFileSystemArchive::findFileInfo
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 informat...
OgreArchive.h

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Apr 13 2021 08:53:15