Visualization Library 2.0.0

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
ZippedDirectory.hpp
Go to the documentation of this file.
1 /**************************************************************************************/
2 /* */
3 /* Visualization Library */
4 /* http://visualizationlibrary.org */
5 /* */
6 /* Copyright (c) 2005-2020, Michele Bosi */
7 /* All rights reserved. */
8 /* */
9 /* Redistribution and use in source and binary forms, with or without modification, */
10 /* are permitted provided that the following conditions are met: */
11 /* */
12 /* - Redistributions of source code must retain the above copyright notice, this */
13 /* list of conditions and the following disclaimer. */
14 /* */
15 /* - Redistributions in binary form must reproduce the above copyright notice, this */
16 /* list of conditions and the following disclaimer in the documentation and/or */
17 /* other materials provided with the distribution. */
18 /* */
19 /* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED */
21 /* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE */
22 /* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR */
23 /* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES */
24 /* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; */
25 /* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON */
26 /* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT */
27 /* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS */
28 /* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
29 /* */
30 /**************************************************************************************/
31 
32 #ifndef ZippedDirectory_INCLUDE_ONCE
33 #define ZippedDirectory_INCLUDE_ONCE
34 
36 #include <vlCore/DiskFile.hpp>
37 #include <vlCore/ZippedFile.hpp>
38 #include <algorithm>
39 
40 namespace vl
41 {
42 //---------------------------------------------------------------------------
43 // ZippedDirectory
44 //---------------------------------------------------------------------------
59  {
61 
62  public:
64 
65  ZippedDirectory(const String& zip_file);
66 
67  ZippedDirectory(VirtualFile* zip_file);
68 
69  bool setPath(const String& name);
70 
71  const VirtualFile* sourceZipFile() const;
72 
73  VirtualFile* sourceZipFile();
74 
75  void setSourceZipFile(VirtualFile* file);
76 
78  void reset();
79 
80  ref<VirtualFile> file(const String& name) const;
81 
83  ref<ZippedFile> zippedFile(const String& name) const;
84 
85  void listFilesRecursive(std::vector<String>& file_list ) const;
86 
87  int zippedFileCount() const;
88 
89  const ZippedFile* zippedFile(int index) const;
90 
91  ZippedFile* zippedFile(int index);
92 
93  void listSubDirs(std::vector<String>& dirs, bool append=false) const;
94  ref<ZippedDirectory> zippedSubDir(const String& subdir_name) const;
95  ref<VirtualDirectory> subDir(const String& subdir_name) const { return zippedSubDir(subdir_name); }
96 
97  void listFiles(std::vector<String>& file_list, bool append=false) const;
98 
99  bool isCorrupted();
100 
101  protected:
102  bool init();
103 
104  protected:
105  std::map< String, ref<ZippedFile> > mFiles;
107  };
108 
109 }
110 
111 #endif
112 
std::map< String, ref< ZippedFile > > mFiles
An abstract class representing a file.
Definition: VirtualFile.hpp:60
The String class implements an advanced UTF16 (Unicode BMP) string manipulation engine.
Definition: String.hpp:62
ref< VirtualFile > mSourceZipFile
#define VL_INSTRUMENT_CLASS(ClassName, BaseClass)
Definition: TypeInfo.hpp:122
Visualization Library main namespace.
Abstact class representing a directory of files.
ref< VirtualDirectory > subDir(const String &subdir_name) const
A VirtualDirectory capable of reading files from a .zip file.
The ref<> class is used to reference-count an Object.
Definition: Object.hpp:55
A VirtualFile used to read a file contained in a .zip archive.
Definition: ZippedFile.hpp:133