1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/***************************************************************************
* Copyright (C) 2005-2019 by the FIFE team *
* http://www.fifengine.net *
* This file is part of FIFE. *
* *
* FIFE is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef FIFE_VFS_VFSSOURCEPROVIDER_H
#define FIFE_VFS_VFSSOURCEPROVIDER_H
// Standard C++ library includes
#include <string>
// 3rd party library includes
// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/exception.h"
namespace FIFE {
class VFSSource;
/** VFSSourceProvider abstract baseclass
*
* If you add support for a new archive-type (like the fallout1&dat files) you should
* also create a new VFSSourceProvider for your VFSSource - once this is done
* its very easy to load new archives even without knowing their real type.
* @see VFS
* @see VFSSource
* @see VFSSourceFactory
*/
class VFSSourceProvider{
public:
VFSSourceProvider(const std::string& name);
virtual ~VFSSourceProvider();
/** Returns the name of this VFSSourceProvider
*
* @return name
*/
const std::string& getName() const;
/** Get the VFS this provider is using. Providers will not be able to locate
* sources before a VFS is set. VFS::addProvider sets this automatically.
*/
void setVFS(VFS* vfs);
VFS* getVFS() const {
if(!m_vfs) throw NotSet("Attempt to load from VFSSourceProvider without setting a VFS!");
return m_vfs;
}
/** Check if a given file is readable for this VFSSource
*
*
* @param file the filename to check
* @return true if readable, false otherwise
*/
virtual bool isReadable(const std::string& file) const = 0;
/** Create a new instance of a VFSSource initialized with the given file
*
* @param file the filename to open (the archive-file)
* @return the new VFSSource
*/
virtual VFSSource* createSource(const std::string& file) = 0;
/** Get the source instance of the path
*
* @param path The source path
* @return A VFSSource or NULL of none is present
*/
virtual VFSSource* getSource(const std::string& path) const = 0;
/** Check whether the provider already has created a source with that path
*
* @param path The path to the source
* @return true if the provider has already created a source with that path, false if not
*/
virtual bool hasSource(const std::string & path) const = 0;
private:
VFS* m_vfs;
std::string m_name;
};
}
#endif
|
