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-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 __FileSystem_H__
00030 #define __FileSystem_H__
00031 
00032 #include "OgrePrerequisites.h"
00033 
00034 #include "OgreArchive.h"
00035 #include "OgreArchiveFactory.h"
00036 
00037 namespace Ogre {
00038 
00042     class _OgreExport FileSystemArchive : public Archive 
00043     {
00044     protected:
00055         void findFiles(const String& pattern, bool recursive, bool dirs,
00056             StringVector* simpleList, FileInfoList* detailList);
00057 
00058     public:
00059         FileSystemArchive(const String& name, const String& archType );
00060         ~FileSystemArchive();
00061 
00063         bool isCaseSensitive(void) const;
00064 
00066         void load();
00068         void unload();
00069 
00071         DataStreamPtr open(const String& filename) const;
00072 
00074         StringVectorPtr list(bool recursive = true, bool dirs = false);
00075 
00077         FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false);
00078 
00080         StringVectorPtr find(const String& pattern, bool recursive = true,
00081             bool dirs = false);
00082 
00084         FileInfoListPtr findFileInfo(const String& pattern, bool recursive = true,
00085             bool dirs = false);
00086 
00088         bool exists(const String& filename);
00089 
00091         time_t getModifiedTime(const String& filename);
00092 
00096         static void setIgnoreHidden(bool ignore)
00097         {
00098             ms_IgnoreHidden = ignore;
00099         }
00100 
00102         static bool getIgnoreHidden()
00103         {
00104             return ms_IgnoreHidden;
00105         }
00106 
00107         static bool ms_IgnoreHidden;
00108     };
00109 
00111     //class _OgrePrivate FileSystemArchiveFactory : public ArchiveFactory
00112     class _OgreExport FileSystemArchiveFactory : public ArchiveFactory
00113     {
00114     public:
00115         virtual ~FileSystemArchiveFactory() {}
00117         const String& getType(void) const;
00119         Archive *createInstance( const String& name ) 
00120         {
00121             return OGRE_NEW FileSystemArchive(name, "FileSystem");
00122         }
00124         void destroyInstance( Archive* arch) { delete arch; }
00125     };
00126 
00127 
00128 }
00129 
00130 #endif

Copyright © 2008 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:02:23 2009