OGRE: OgreArchive.h Source File - OGRE Documentation

# 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 #include <ctime>
    00038
    00039 namespace Ogre {
    00040
    00046     struct FileInfo {
    00049         Archive* archive;
    00051         String filename;
    00053         String path;
    00055         String basename;
    00057         size_t compressedSize;
    00059         size_t uncompressedSize;
    00060     };
    00061
    00062     typedef std::vector<FileInfo> FileInfoList;
    00063     typedef SharedPtr<FileInfoList> FileInfoListPtr;
    00064
    00081     class _OgreExport Archive : public ArchiveAlloc
    00082     {
    00083     protected:
    00085         String mName;
    00087         String mType;
    00088     public:
    00089
    00090
    00093         Archive( const String& name, const String& archType )
    00094             : mName(name), mType(archType) {}
    00095
    00098         virtual ~Archive() {}
    00099
    00101         const String& getName(void) const { return mName; }
    00102
    00104         virtual bool isCaseSensitive(void) const = 0;
    00105
    00113         virtual void load() = 0;
    00114
    00120         virtual void unload() = 0;
    00121
    00131         virtual DataStreamPtr open(const String& filename) const = 0;
    00132
    00143         virtual StringVectorPtr list(bool recursive = true, bool dirs = false) = 0;
    00144
    00153         virtual FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false) = 0;
    00154
    00167         virtual StringVectorPtr find(const String& pattern, bool recursive = true,
    00168             bool dirs = false) = 0;
    00169
    00171         virtual bool exists(const String& filename) = 0;
    00172
    00174         virtual time_t getModifiedTime(const String& filename) = 0;
    00175
    00176
    00187         virtual FileInfoListPtr findFileInfo(const String& pattern,
    00188             bool recursive = true, bool dirs = false) = 0;
    00189
    00191         const String& getType(void) const { return mType; }
    00192
    00193     };
    00194 }
    00195
    00196 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:32:16 2009