OgreArchive.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef _Archive_H__
29#define _Archive_H__
30
31#include "OgrePrerequisites.h"
32#include "OgreString.h"
33#include "OgreDataStream.h"
34#include "OgreSharedPtr.h"
35#include "OgreStringVector.h"
36#include "OgreException.h"
37#include <ctime>
38#include "OgreHeaderPrefix.h"
39
40namespace Ogre {
41
53 struct FileInfo {
67 };
68
71
89 {
90 protected:
97 public:
98
99
102 Archive( const String& name, const String& archType )
103 : mName(name), mType(archType), mReadOnly(true) {}
104
107 virtual ~Archive() {}
108
110 const String& getName(void) const { return mName; }
111
113 virtual bool isCaseSensitive(void) const = 0;
114
122 virtual void load() = 0;
123
129 virtual void unload() = 0;
130
134 virtual bool isReadOnly() const { return mReadOnly; }
135
147 virtual DataStreamPtr open(const String& filename, bool readOnly = true) const = 0;
148
155 virtual DataStreamPtr create(const String& filename) const
156 {
157 (void)filename;
159 "This archive does not support creation of files.",
160 "Archive::create");
161 }
162
167 virtual void remove(const String& filename) const
168 {
169 (void)filename;
171 "This archive does not support removal of files.",
172 "Archive::remove");
173 }
174
185 virtual StringVectorPtr list(bool recursive = true, bool dirs = false) = 0;
186
195 virtual FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false) = 0;
196
209 virtual StringVectorPtr find(const String& pattern, bool recursive = true,
210 bool dirs = false) = 0;
211
213 virtual bool exists(const String& filename) = 0;
214
216 virtual time_t getModifiedTime(const String& filename) = 0;
217
218
229 virtual FileInfoListPtr findFileInfo(const String& pattern,
230 bool recursive = true, bool dirs = false) const = 0;
231
233 const String& getType(void) const { return mType; }
234
235 };
239}
240
241#include "OgreHeaderSuffix.h"
242
243#endif
#define _OgreExport
Definition: OgrePlatform.h:257
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Archive-handling class.
Definition: OgreArchive.h:89
virtual DataStreamPtr create(const String &filename) const
Create a new file (or overwrite one already there).
Definition: OgreArchive.h:155
virtual bool isReadOnly() const
Reports whether this Archive is read-only, or whether the contents can be updated.
Definition: OgreArchive.h:134
virtual ~Archive()
Default destructor.
Definition: OgreArchive.h:107
virtual bool isCaseSensitive(void) const =0
Returns whether this archive is case sensitive in the way it matches files.
virtual time_t getModifiedTime(const String &filename)=0
Retrieve the modification time of a given file.
virtual FileInfoListPtr listFileInfo(bool recursive=true, bool dirs=false)=0
List all files in the archive with accompanying information.
virtual void unload()=0
Unloads the archive.
virtual void load()=0
Loads the archive.
virtual StringVectorPtr list(bool recursive=true, bool dirs=false)=0
List all file names in the archive.
virtual void remove(const String &filename) const
Delete a named file.
Definition: OgreArchive.h:167
virtual StringVectorPtr find(const String &pattern, bool recursive=true, bool dirs=false)=0
Find all file or directory names matching a given pattern in this archive.
virtual DataStreamPtr open(const String &filename, bool readOnly=true) const =0
Open a stream on a given file.
virtual FileInfoListPtr findFileInfo(const String &pattern, bool recursive=true, bool dirs=false) const =0
Find all files or directories matching a given pattern in this archive and get some detailed informat...
Archive(const String &name, const String &archType)
Constructor - don't call direct, used by ArchiveFactory.
Definition: OgreArchive.h:102
String mName
Archive name.
Definition: OgreArchive.h:92
const String & getType(void) const
Return the type code of this Archive.
Definition: OgreArchive.h:233
String mType
Archive type code.
Definition: OgreArchive.h:94
bool mReadOnly
Read-only flag.
Definition: OgreArchive.h:96
virtual bool exists(const String &filename)=0
Find out if the named file exists (note: fully qualified filename required)
const String & getName(void) const
Get the name of this archive.
Definition: OgreArchive.h:110
Reference-counted shared pointer, used for objects where implicit destruction is required.
#define OGRE_EXCEPT(num, desc, src)
vector< FileInfo >::type FileInfoList
Definition: OgreArchive.h:69
SharedPtr< FileInfoList > FileInfoListPtr
Definition: OgreArchive.h:70
_StringBase String
Information about a file/directory within the archive will be returned using a FileInfo struct.
Definition: OgreArchive.h:53
const Archive * archive
The archive in which the file has been found (for info when performing multi-Archive searches,...
Definition: OgreArchive.h:56
size_t uncompressedSize
Uncompressed size.
Definition: OgreArchive.h:66
String filename
The file's fully qualified name.
Definition: OgreArchive.h:58
String basename
Base filename.
Definition: OgreArchive.h:62
size_t compressedSize
Compressed size.
Definition: OgreArchive.h:64
String path
Path name; separated by '/' and ending with '/'.
Definition: OgreArchive.h:60

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.