Crazy Eddie's GUI System  0.8.4
MinizipResourceProvider.h
00001 /***********************************************************************
00002     created:    19/3/2010
00003     author:     Jeff A. Marr
00004 
00005     purpose:    Defines a resource provider for minizip archives
00006 *************************************************************************/
00007 /***************************************************************************
00008  *   Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
00009  *
00010  *   Permission is hereby granted, free of charge, to any person obtaining
00011  *   a copy of this software and associated documentation files (the
00012  *   "Software"), to deal in the Software without restriction, including
00013  *   without limitation the rights to use, copy, modify, merge, publish,
00014  *   distribute, sublicense, and/or sell copies of the Software, and to
00015  *   permit persons to whom the Software is furnished to do so, subject to
00016  *   the following conditions:
00017  *
00018  *   The above copyright notice and this permission notice shall be
00019  *   included in all copies or substantial portions of the Software.
00020  *
00021  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00022  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00023  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00024  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00025  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00026  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00027  *   OTHER DEALINGS IN THE SOFTWARE.
00028  ***************************************************************************/
00029 #ifndef _CEGUIMinizipResourceProvider_h_
00030 #define _CEGUIMinizipResourceProvider_h_
00031 
00032 #include "CEGUI/Base.h"
00033 #include "CEGUI/DefaultResourceProvider.h"
00034 
00035 #if defined(_MSC_VER)
00036 #   pragma warning(push)
00037 #   pragma warning(disable : 4251)
00038 #endif
00039 
00040 // NOTE: While the DefaultResourceProvider (DRP) was not originally intended
00041 // to be derived from, the purpose of this class is to extend the behavior of
00042 // the default implementation. The only difference is that this class will
00043 // attempt to load resources from a zip archive if the resource does not exist
00044 // outside the archive.
00045 
00046 // Start of CEGUI namespace section
00047 namespace CEGUI
00048 {
00049 class CEGUIEXPORT MinizipResourceProvider : public DefaultResourceProvider
00050 {
00051 public:
00052     /*************************************************************************
00053         Construction and Destruction
00054     *************************************************************************/
00055     MinizipResourceProvider();
00056     MinizipResourceProvider(const String& archive, bool loadLocal = true);
00057     ~MinizipResourceProvider(void);
00058 
00066     void setArchive(const String& archive);
00067     void setLoadLocal(bool load = true);
00068 
00069     void loadRawDataContainer(const String& filename,
00070                               RawDataContainer& output,
00071                               const String& resourceGroup);
00072     size_t getResourceGroupFileNames(std::vector<String>& out_vec,
00073                                      const String& file_pattern,
00074                                      const String& resource_group);
00075 protected:
00076     bool doesFileExist(const String& filename);
00077     void openArchive();
00078     void closeArchive();
00079 
00080     struct Impl;
00081     Impl* d_pimpl;
00082 };
00083 
00084 } // End of  CEGUI namespace section
00085 
00086 #if defined(_MSC_VER)
00087 #   pragma warning(pop)
00088 #endif
00089 
00090 #endif  // end of guard _CEGUIMinizipResourceProvider_h_
00091 
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends