Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

OgreArchive.h

Go to the documentation of this file.
00001 /*
00002 -----------------------------------------------------------------------------
00003 This source file is part of OGRE
00004 (Object-oriented Graphics Rendering Engine)
00005 For the latest info, see http://www.ogre3d.org/
00006 
00007 Copyright (c) 2000-2006 Torus Knot Software Ltd
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 
00024 You may alternatively use this source under the terms of a specific version of
00025 the OGRE Unrestricted License provided you have obtained such a license from
00026 Torus Knot Software Ltd.
00027 -----------------------------------------------------------------------------
00028 */
00029 #ifndef _Archive_H__
00030 #define _Archive_H__
00031 
00032 #include "OgrePrerequisites.h"
00033 #include "OgreString.h"
00034 #include "OgreDataStream.h"
00035 #include "OgreSharedPtr.h"
00036 #include "OgreStringVector.h"
00037 
00038 namespace Ogre {
00039 
00045     struct FileInfo {
00048         Archive* archive;
00050         String filename;
00052         String path;
00054         String basename;
00056         size_t compressedSize;
00058         size_t uncompressedSize;
00059     };
00060 
00061     typedef std::vector<FileInfo> FileInfoList;
00062     typedef SharedPtr<FileInfoList> FileInfoListPtr;
00063 
00080     class _OgreExport Archive  
00081     {
00082     protected:
00084         String mName; 
00086         String mType;
00087     public:
00088 
00089 
00092         Archive( const String& name, const String& archType )
00093             : mName(name), mType(archType) {}
00094 
00097         virtual ~Archive() {}
00098 
00100         const String& getName(void) const { return mName; }
00101 
00103         virtual bool isCaseSensitive(void) const = 0;
00104 
00112         virtual void load() = 0;
00113 
00119         virtual void unload() = 0;
00120 
00130         virtual DataStreamPtr open(const String& filename) const = 0;
00131 
00142         virtual StringVectorPtr list(bool recursive = true, bool dirs = false) = 0;
00143         
00152         virtual FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false) = 0;
00153 
00166         virtual StringVectorPtr find(const String& pattern, bool recursive = true,
00167             bool dirs = false) = 0;
00168 
00170         virtual bool exists(const String& filename) = 0; 
00171 
00182         virtual FileInfoListPtr findFileInfo(const String& pattern, 
00183             bool recursive = true, bool dirs = false) = 0;
00184 
00186         const String& getType(void) const { return mType; }
00187         
00188     };
00189 }
00190 
00191 #endif

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Aug 20 13:50:45 2007