OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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-2014 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
time_t getModifiedTime(const String &filename)
Retrieve the modification time of a given file.
StringVectorPtr list(bool recursive=true, bool dirs=false)
List all file names in the 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 informat...
StringVectorPtr find(const String &pattern, bool recursive=true, bool dirs=false)
Find all file or directory names matching a given pattern in this archive.
APKFileSystemArchive(const String &name, const String &archType, AAssetManager *assetMgr)
bool isCaseSensitive(void) const
Returns whether this archive is case sensitive in the way it matches files.
const String & getType(void) const
Returns the factory type.
DataStreamPtr create(const String &filename) const
Create a new file (or overwrite one already there).
#define OGRE_DELETE
FileInfoListPtr listFileInfo(bool recursive=true, bool dirs=false)
List all files in the archive with accompanying information.
DataStreamPtr open(const String &filename, bool readOnly=true) const
Open a stream on a given file.
Abstract factory class, archive codec plugins can register concrete subclasses of this...
#define OGRE_NEW
Archive-handling class.
Definition: OgreArchive.h:86
void destroyInstance(Archive *arch)
Destroys an object which was created by this factory.
_StringBase String
Definition: OgreCommon.h:53
void load()
Loads the archive.
bool exists(const String &filename)
Find out if the named file exists (note: fully qualified filename required)
Archive * createInstance(const String &name, bool readOnly)
Creates a new object.
APKFileSystemArchiveFactory(AAssetManager *assetMgr)
void unload()
Unloads the archive.