OGRE: OgreFileSystem.h Source File - OGRE Documentation

# OgreFileSystem.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-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __FileSystem_H__
    00029 #define __FileSystem_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032
    00033 #include "OgreArchive.h"
    00034 #include "OgreArchiveFactory.h"
    00035
    00036 namespace Ogre {
    00037
    00047     class _OgreExport FileSystemArchive : public Archive
    00048     {
    00049     protected:
    00060         void findFiles(const String& pattern, bool recursive, bool dirs,
    00061             StringVector* simpleList, FileInfoList* detailList);
    00062
    00063         OGRE_AUTO_MUTEX
    00064     public:
    00065         FileSystemArchive(const String& name, const String& archType );
    00066         ~FileSystemArchive();
    00067
    00069         bool isCaseSensitive(void) const;
    00070
    00072         void load();
    00074         void unload();
    00075
    00077         DataStreamPtr open(const String& filename, bool readOnly = true) const;
    00078
    00080         DataStreamPtr create(const String& filename) const;
    00081
    00083         void remove(const String& filename) const;
    00084
    00086         StringVectorPtr list(bool recursive = true, bool dirs = false);
    00087
    00089         FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false);
    00090
    00092         StringVectorPtr find(const String& pattern, bool recursive = true,
    00093             bool dirs = false);
    00094
    00096         FileInfoListPtr findFileInfo(const String& pattern, bool recursive = true,
    00097             bool dirs = false);
    00098
    00100         bool exists(const String& filename);
    00101
    00103         time_t getModifiedTime(const String& filename);
    00104
    00108         static void setIgnoreHidden(bool ignore)
    00109         {
    00110             ms_IgnoreHidden = ignore;
    00111         }
    00112
    00114         static bool getIgnoreHidden()
    00115         {
    00116             return ms_IgnoreHidden;
    00117         }
    00118
    00119         static bool ms_IgnoreHidden;
    00120     };
    00121
    00123     //class _OgrePrivate FileSystemArchiveFactory : public ArchiveFactory
    00124     class _OgreExport FileSystemArchiveFactory : public ArchiveFactory
    00125     {
    00126     public:
    00127         virtual ~FileSystemArchiveFactory() {}
    00129         const String& getType(void) const;
    00131         Archive *createInstance( const String& name )
    00132         {
    00133             return OGRE_NEW FileSystemArchive(name, "FileSystem");
    00134         }
    00136         void destroyInstance( Archive* arch) { delete arch; }
    00137     };
    00138
    00142 }
    00143
    00144 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:51