OgreZip.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 #ifndef __Zip_H__
29 #define __Zip_H__
30 
31 #include "OgrePrerequisites.h"
32 
33 #include "OgreArchive.h"
34 #include "OgreArchiveFactory.h"
35 #if OGRE_THREAD_SUPPORT
37 #endif
38 #include "OgreHeaderPrefix.h"
39 
40 // Forward declaration for zziplib to avoid header file dependency.
41 typedef struct zzip_dir ZZIP_DIR;
42 typedef struct zzip_file ZZIP_FILE;
43 typedef union _zzip_plugin_io zzip_plugin_io_handlers;
44 
45 namespace Ogre {
46 
59  class _OgreExport ZipArchive : public Archive
60  {
61  protected:
65  void checkZzipError(int zzipError, const String& operation) const;
70 
72  public:
73  ZipArchive(const String& name, const String& archType, zzip_plugin_io_handlers* pluginIo = NULL);
76  bool isCaseSensitive(void) const { return false; }
77 
79  void load();
81  void unload();
82 
84  DataStreamPtr open(const String& filename, bool readOnly = true) const;
85 
87  DataStreamPtr create(const String& filename) const;
88 
90  void remove(const String& filename) const;
91 
93  StringVectorPtr list(bool recursive = true, bool dirs = false);
94 
96  FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false);
97 
99  StringVectorPtr find(const String& pattern, bool recursive = true,
100  bool dirs = false);
101 
103  FileInfoListPtr findFileInfo(const String& pattern, bool recursive = true,
104  bool dirs = false) const;
105 
107  bool exists(const String& filename);
108 
110  time_t getModifiedTime(const String& filename);
111  };
112 
115  {
116  public:
117  virtual ~ZipArchiveFactory() {}
119  const String& getType(void) const;
121  Archive *createInstance( const String& name, bool readOnly )
122  {
123  if(!readOnly)
124  return NULL;
125 
126  return OGRE_NEW ZipArchive(name, "Zip");
127  }
129  void destroyInstance( Archive* ptr) { OGRE_DELETE ptr; }
130  };
131 
134  {
135  protected:
138  public:
142  const String& getType(void) const;
144  Archive *createInstance( const String& name, bool readOnly )
145  {
146  ZipArchive * resZipArchive = OGRE_NEW ZipArchive(name, "EmbeddedZip", mPluginIo);
147  return resZipArchive;
148  }
149 
156  typedef bool (*DecryptEmbeddedZipFileFunc)(size_t pos, void* buf, size_t len);
157 
159  static void addEmbbeddedFile(const String& name, const uint8 * fileData,
160  size_t fileSize, DecryptEmbeddedZipFileFunc decryptFunc);
161 
163  static void removeEmbbeddedFile(const String& name);
164 
165  };
166 
169  {
170  protected:
174  public:
176  ZipDataStream(ZZIP_FILE* zzipFile, size_t uncompressedSize);
178  ZipDataStream(const String& name, ZZIP_FILE* zzipFile, size_t uncompressedSize);
181  size_t read(void* buf, size_t count);
183  size_t write(void* buf, size_t count);
185  void skip(long count);
187  void seek( size_t pos );
189  size_t tell(void) const;
191  bool eof(void) const;
193  void close(void);
194 
195 
196  };
197 
201 }
202 
203 #include "OgreHeaderSuffix.h"
204 
205 #endif
OgreHeaderSuffix.h
Ogre::ZipArchive::load
void load()
Loads the archive.
Ogre::EmbeddedZipArchiveFactory::EmbeddedZipArchiveFactory
EmbeddedZipArchiveFactory()
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::ZipArchive::mZzipDir
ZZIP_DIR * mZzipDir
Handle to root zip file.
Definition: OgreZip.h:63
Ogre::ZipArchive::~ZipArchive
~ZipArchive()
Ogre::ZipArchive::create
DataStreamPtr create(const String &filename) const
Create a new file (or overwrite one already there).
Ogre::ZipArchive::mFileList
FileInfoList mFileList
File list (since zziplib seems to only allow scanning of dir tree once)
Definition: OgreZip.h:67
OGRE_DELETE
#define OGRE_DELETE
Definition: OgreMemoryAllocatorConfig.h:474
Ogre::DataStream
General purpose class used for encapsulating the reading and writing of data.
Definition: OgreDataStream.h:177
Ogre::ZipDataStream::close
void close(void)
Close the stream; this makes further operations invalid.
Ogre::ZipDataStream
Specialisation of DataStream to handle streaming data from zip archives.
Definition: OgreZip.h:169
Ogre::ZipArchive::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...
Ogre::ZipDataStream::mZzipFile
ZZIP_FILE * mZzipFile
Definition: OgreZip.h:171
Ogre::ZipDataStream::ZipDataStream
ZipDataStream(ZZIP_FILE *zzipFile, size_t uncompressedSize)
Unnamed constructor.
ZZIP_DIR
struct zzip_dir ZZIP_DIR
Definition: OgreZip.h:41
Ogre::ZipDataStream::read
size_t read(void *buf, size_t count)
Read the requisite number of bytes from the stream, stopping at the end of the file.
Ogre::ZipArchiveFactory::getType
const String & getType(void) const
Returns the factory type.
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::ZipArchive::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::ArchiveFactory
Abstract factory class, archive codec plugins can register concrete subclasses of this.
Definition: OgreArchiveFactory.h:60
ZZIP_FILE
struct zzip_file ZZIP_FILE
Definition: OgreZip.h:42
Ogre::ZipArchive::ZipArchive
ZipArchive(const String &name, const String &archType, zzip_plugin_io_handlers *pluginIo=NULL)
Ogre::ZipArchive::remove
void remove(const String &filename) const
Delete a named file.
Ogre::ZipArchiveFactory
Specialisation of ArchiveFactory for Zip files.
Definition: OgreZip.h:115
Ogre::ZipArchive::checkZzipError
void checkZzipError(int zzipError, const String &operation) const
Handle any errors from zzip.
OgreArchiveFactory.h
Ogre::ZipArchive::exists
bool exists(const String &filename)
Find out if the named file exists (note: fully qualified filename required)
OgreHeaderPrefix.h
Ogre::ZipDataStream::eof
bool eof(void) const
Returns true if the stream has reached the end.
Ogre::ZipArchive::listFileInfo
FileInfoListPtr listFileInfo(bool recursive=true, bool dirs=false)
List all files in the archive with accompanying information.
Ogre::ZipArchiveFactory::destroyInstance
void destroyInstance(Archive *ptr)
Destroys an object which was created by this factory.
Definition: OgreZip.h:129
Ogre::EmbeddedZipArchiveFactory::removeEmbbeddedFile
static void removeEmbbeddedFile(const String &name)
Remove an embedded file to the embedded file list.
OgrePrerequisites.h
Ogre::ZipDataStream::ZipDataStream
ZipDataStream(const String &name, ZZIP_FILE *zzipFile, size_t uncompressedSize)
Constructor for creating named streams.
Ogre::ZipArchiveFactory::createInstance
Archive * createInstance(const String &name, bool readOnly)
Creates a new object.
Definition: OgreZip.h:121
Ogre::ZipArchiveFactory::~ZipArchiveFactory
virtual ~ZipArchiveFactory()
Definition: OgreZip.h:117
OgreThreadHeaders.h
Ogre::ZipDataStream::mCache
StaticCache< 2 *OGRE_STREAM_TEMP_SIZE > mCache
We need caching because sometimes serializers step back in data stream and zziplib behaves slow.
Definition: OgreZip.h:173
Ogre::EmbeddedZipArchiveFactory
Specialisation of ZipArchiveFactory for embedded Zip files.
Definition: OgreZip.h:134
Ogre::EmbeddedZipArchiveFactory::~EmbeddedZipArchiveFactory
virtual ~EmbeddedZipArchiveFactory()
Ogre::ZipArchive::open
DataStreamPtr open(const String &filename, bool readOnly=true) const
Open a stream on a given file.
Ogre::EmbeddedZipArchiveFactory::mPluginIo
static zzip_plugin_io_handlers * mPluginIo
A static pointer to file io alternative implementation for the embedded files.
Definition: OgreZip.h:137
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::ZipArchive::mPluginIo
zzip_plugin_io_handlers * mPluginIo
A pointer to file io alternative implementation.
Definition: OgreZip.h:69
Ogre::ZipDataStream::seek
void seek(size_t pos)
Repositions the read point to a specified byte.
Ogre::EmbeddedZipArchiveFactory::addEmbbeddedFile
static void addEmbbeddedFile(const String &name, const uint8 *fileData, size_t fileSize, DecryptEmbeddedZipFileFunc decryptFunc)
Add an embedded file to the embedded file list.
zzip_plugin_io_handlers
union _zzip_plugin_io zzip_plugin_io_handlers
Definition: OgreZip.h:43
Ogre::SharedPtr< DataStream >
Ogre::uint8
unsigned char uint8
Definition: OgrePlatform.h:361
Ogre::ZipArchive::getModifiedTime
time_t getModifiedTime(const String &filename)
Retrieve the modification time of a given file.
Ogre::FileInfoList
vector< FileInfo >::type FileInfoList
Definition: OgreArchive.h:69
Ogre::ZipDataStream::skip
void skip(long count)
Skip a defined number of bytes.
Ogre::ZipDataStream::tell
size_t tell(void) const
Repositions the read point to a specified byte.
Ogre::EmbeddedZipArchiveFactory::getType
const String & getType(void) const
Returns the factory type.
_OgrePrivate
#define _OgrePrivate
Definition: OgrePlatform.h:258
Ogre::Archive
Archive-handling class.
Definition: OgreArchive.h:89
Ogre::ZipArchive
Specialisation of the Archive class to allow reading of files from a zip format source archive.
Definition: OgreZip.h:60
OGRE_NEW
#define OGRE_NEW
Definition: OgreMemoryAllocatorConfig.h:473
Ogre::ZipArchive::list
StringVectorPtr list(bool recursive=true, bool dirs=false)
List all file names in the archive.
Ogre::ZipDataStream::write
size_t write(void *buf, size_t count)
Write the requisite number of bytes from the stream (only applicable to streams that are not read-onl...
Ogre::StaticCache< 2 *OGRE_STREAM_TEMP_SIZE >
Ogre::ZipArchive::unload
void unload()
Unloads the archive.
Ogre::ZipArchive::isCaseSensitive
bool isCaseSensitive(void) const
Returns whether this archive is case sensitive in the way it matches files.
Definition: OgreZip.h:76
OgreArchive.h
Ogre::ZipArchive::OGRE_AUTO_MUTEX
OGRE_AUTO_MUTEX
Definition: OgreZip.h:71
Ogre::ZipDataStream::~ZipDataStream
~ZipDataStream()
Ogre::EmbeddedZipArchiveFactory::createInstance
Archive * createInstance(const String &name, bool readOnly)
Creates a new object.
Definition: OgreZip.h:144

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.