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);
74  ~ZipArchive();
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:
140  virtual ~EmbeddedZipArchiveFactory();
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);
179  ~ZipDataStream();
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

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 Wed Oct 23 2013 06:57:26