OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreFileSystem.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __FileSystem_H__
29 #define __FileSystem_H__
30 
31 #include "OgrePrerequisites.h"
32 
33 #include "OgreArchive.h"
34 #include "OgreArchiveFactory.h"
36 #include "OgreHeaderPrefix.h"
37 
38 namespace Ogre {
39 
50  {
51  protected:
64  void findFiles(const String& pattern, bool recursive, bool dirs,
65  StringVector* simpleList, FileInfoList* detailList) const;
66 
68  public:
69  FileSystemArchive(const String& name, const String& archType, bool readOnly );
71 
73  bool isCaseSensitive(void) const;
74 
76  void load();
78  void unload();
79 
81  DataStreamPtr open(const String& filename, bool readOnly = true) const;
82 
84  DataStreamPtr create(const String& filename) const;
85 
87  void remove(const String& filename) const;
88 
90  StringVectorPtr list(bool recursive = true, bool dirs = false);
91 
93  FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false);
94 
96  StringVectorPtr find(const String& pattern, bool recursive = true,
97  bool dirs = false);
98 
100  FileInfoListPtr findFileInfo(const String& pattern, bool recursive = true,
101  bool dirs = false) const;
102 
104  bool exists(const String& filename);
105 
107  time_t getModifiedTime(const String& filename);
108 
112  static void setIgnoreHidden(bool ignore)
113  {
114  msIgnoreHidden = ignore;
115  }
116 
118  static bool getIgnoreHidden()
119  {
120  return msIgnoreHidden;
121  }
122 
123  static bool msIgnoreHidden;
124  };
125 
128  {
129  public:
132  const String& getType(void) const;
134  Archive *createInstance( const String& name, bool readOnly )
135  {
136  return OGRE_NEW FileSystemArchive(name, "FileSystem", readOnly);
137  }
139  void destroyInstance(Archive* ptr) { OGRE_DELETE ptr; }
140  };
141 
145 } // namespace Ogre
146 
147 #include "OgreHeaderSuffix.h"
148 
149 #endif // __FileSystem_H__
#define _OgreExport
Definition: OgrePlatform.h:255
Specialisation of ArchiveFactory for FileSystem files.
Archive * createInstance(const String &name, bool readOnly)
Creates a new object.
static void setIgnoreHidden(bool ignore)
Set whether filesystem enumeration will include hidden files or not.
vector< String >::type StringVector
#define OGRE_DELETE
static bool getIgnoreHidden()
Get whether hidden files are ignored during filesystem enumeration.
Abstract factory class, archive codec plugins can register concrete subclasses of this...
vector< FileInfo >::type FileInfoList
Definition: OgreArchive.h:67
#define OGRE_NEW
Archive-handling class.
Definition: OgreArchive.h:86
_StringBase String
Definition: OgreCommon.h:53
void destroyInstance(Archive *ptr)
Destroys an object which was created by this factory.
Specialisation of the Archive class to allow reading of files from filesystem folders / directories...