Crazy Eddie's GUI System  0.8.7
MinizipResourceProvider.h
1 /***********************************************************************
2  created: 19/3/2010
3  author: Jeff A. Marr
4 
5  purpose: Defines a resource provider for minizip archives
6 *************************************************************************/
7 /***************************************************************************
8  * Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining
11  * a copy of this software and associated documentation files (the
12  * "Software"), to deal in the Software without restriction, including
13  * without limitation the rights to use, copy, modify, merge, publish,
14  * distribute, sublicense, and/or sell copies of the Software, and to
15  * permit persons to whom the Software is furnished to do so, subject to
16  * the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be
19  * included in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
24  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
25  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27  * OTHER DEALINGS IN THE SOFTWARE.
28  ***************************************************************************/
29 #ifndef _CEGUIMinizipResourceProvider_h_
30 #define _CEGUIMinizipResourceProvider_h_
31 
32 #include "CEGUI/Base.h"
33 #include "CEGUI/DefaultResourceProvider.h"
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 // NOTE: While the DefaultResourceProvider (DRP) was not originally intended
41 // to be derived from, the purpose of this class is to extend the behavior of
42 // the default implementation. The only difference is that this class will
43 // attempt to load resources from a zip archive if the resource does not exist
44 // outside the archive.
45 
46 // Start of CEGUI namespace section
47 namespace CEGUI
48 {
50 {
51 public:
52  /*************************************************************************
53  Construction and Destruction
54  *************************************************************************/
56  MinizipResourceProvider(const String& archive, bool loadLocal = true);
58 
66  void setArchive(const String& archive);
67  void setLoadLocal(bool load = true);
68 
69  void loadRawDataContainer(const String& filename,
70  RawDataContainer& output,
71  const String& resourceGroup);
72  size_t getResourceGroupFileNames(std::vector<String>& out_vec,
73  const String& file_pattern,
74  const String& resource_group);
75 protected:
76  bool doesFileExist(const String& filename);
77  void openArchive();
78  void closeArchive();
79 
80  struct Impl;
81  Impl* d_pimpl;
82 };
83 
84 } // End of CEGUI namespace section
85 
86 #if defined(_MSC_VER)
87 # pragma warning(pop)
88 #endif
89 
90 #endif // end of guard _CEGUIMinizipResourceProvider_h_
91 
Definition: MinizipResourceProvider.h:49
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
Class used as the databuffer for loading files throughout the library.
Definition: DataContainer.h:42
Definition: DefaultResourceProvider.h:45
String class used within the GUI system.
Definition: String.h:62