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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
/*
Ousía
Copyright (C) 2014, 2015 Benjamin Paaßen, Andreas Stöckel
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _OUSIA_RESOURCE_LOCATOR_HPP_
#define _OUSIA_RESOURCE_LOCATOR_HPP_
#include <istream>
#include <memory>
#include <vector>
#include "Resource.hpp"
namespace ousia {
// Forward declaration
class ResourceLocator;
/**
* A ResourceLocator is a class able to locate resources in some way, usually
* on the hard drive.
*
* We specify this as an abstract superclass to have an interface layer between
* the program core and possible future extensions in terms of resource
* locations (e.g. online resources, .zip files, etc.).
*/
class ResourceLocator {
protected:
/**
* The locate function uses this ResourceLocator to search for a given
* Resource name (path parameter). It returns a Location with the
* 'valid' flag set accordingly.
*
* @param resource reference to a Resource the will be set the the found
* location. The content of the variable will be only valid if the return
* value of this function is set to true.
* @param path is the resource name.
* @param relativeTo is an already resolved fully qualified name/canonical
* path that is to be used as base directory for this search. It is
* guaranteed that the path was produced by this locator instance. Otherwise
* this argument is set to an empty string.
* @param type is the type of this resource.
* @return true if a resource could be found, false otherwise.
*/
virtual bool doLocate(Resource &resource, const std::string &path,
const ResourceType type,
const std::string &relativeTo) const = 0;
/**
* Tries to autocomplete the given filename by searching for files with this
* basename but different extensions. Returns a list of possible extended
* paths. May return an empty list if this function is not supported.
*
* @param path is the given filename for which versions with extension
* should be searched.
* @param type is the resource type, determining the search paths in which
* the resource is looked up.
* @param relativeTo is an already resolved Resource relative to which the
* file should be searched.
* @return a list of matching, autocompleted file paths.
*/
virtual std::vector<std::string> doAutocomplete(
const std::string &path, const ResourceType type,
const std::string &relativeTo) const;
/**
* This method returns a stream containing the data of the resource at the
* given location.
*
* @param location is a found location, most likely from a Location.
*
* @return a stream containing the data of the Resource at this
* location. This has to be a unique_pointer because the current
* C++11 compiler does not yet support move semantics for
* streams.
*/
virtual std::unique_ptr<std::istream> doStream(
const std::string &location) const = 0;
public:
/**
* Virtual destructor of the ResourceLocator interface.
*/
virtual ~ResourceLocator() {}
/**
* Tries to autocomplete the given filename by searching for files with this
* basename but different extensions. Returns a list of possible extended
* paths. May return an empty list if this function is not supported.
*
* @param path is the given filename for which versions with extension
* should be searched.
* @param type is the resource type, determining the search paths in which
* the resource is looked up.
* @param relativeTo is an already resolved Resource relative to which the
* file should be searched.
* @return a list of matching, autocompleted file paths.
*/
std::vector<std::string> autocomplete(
const std::string &path,
const ResourceType type = ResourceType::UNKNOWN,
const Resource &relativeTo = NullResource) const;
/**
* Tries to autocomplete the given filename by searching for files with this
* basename but different extensions. Returns a list of possible extended
* paths. May return an empty list if this function is not supported.
*
* @param path is the given filename for which versions with extension
* should be searched.
* @param type is the resource type, determining the search paths in which
* the resource is looked up.
* @param relativeTo is the location of an already resolved resource
* relative to which this resource should be located.
* @return a list of matching, autocompleted file paths.
*/
std::vector<std::string> autocomplete(const std::string &path,
const ResourceType type,
const std::string &relativeTo) const;
/**
* The locate function uses this ResourceLocator to search for a given
* Resource name (path parameter).
*
* @param resource reference to a Resource the will be set the the found
* location. The content of the variable will be only valid if the return
* value of this function is set to true.
* @param path is the resource name.
* @param relativeTo is an already resolved Resource.
* @param type is the type of this resource.
* @return true if a resource could be found, false otherwise.
*/
bool locate(Resource &resource, const std::string &path,
const ResourceType type = ResourceType::UNKNOWN,
const Resource &relativeTo = NullResource) const;
/**
* The locate function uses this ResourceLocator to search for a given
* Resource name (path parameter).
*
* @param resource reference to a Resource the will be set the the found
* location. The content of the variable will be only valid if the return
* value of this function is set to true.
* @param path is the resource name.
* @param type is the type of this resource.
* @param relativeTo is the location of an already resolved resource
* relative to which this resource should be located.
* @return true if a resource could be found, false otherwise.
*/
bool locate(Resource &resource, const std::string &path,
const ResourceType type, const std::string &relativeTo) const;
/**
* This method returns a stream containing the data of the resource at the
* given location.
*
* @param location is a found location, most likely from a Location.
*
* @return a stream containing the data of the Resource at this
* location. This has to be a unique_pointer because the current
* C++11 compiler does not yet support move semantics for
* streams.
*/
std::unique_ptr<std::istream> stream(const std::string &location) const;
};
/**
* The StaticResourceLocator class stores a set of predefined resources in
* memory and allows to return these.
*/
class StaticResourceLocator : public ResourceLocator {
private:
/**
* Map containing the paths and the corresponding stored data.
*/
std::map<std::string, std::string> resources;
protected:
/**
* Always returns false.
*/
bool doLocate(Resource &resource, const std::string &path,
const ResourceType type,
const std::string &relativeTo) const override;
/**
* Returns an input stream containing an empty string.
*/
std::unique_ptr<std::istream> doStream(
const std::string &location) const override;
public:
/**
* Stores static (string) data for the given path.
*
* @param path is the path the resource should be stored with.
* @param data is the data that should be stored for that path.
*/
void store(const std::string &path, const std::string &data);
};
/**
* Implementation of the NullResourceLocator - contains a default implementation
* of the ResourceLocator class that does nothing. This class is e.g. used in
* the default constructor of the resource class. A instance of the class is
* provided as "NullResourceLocator".
*/
class NullResourceLocatorImpl : public ResourceLocator {
protected:
/**
* Always returns false.
*/
bool doLocate(Resource &resource, const std::string &path,
const ResourceType type,
const std::string &relativeTo) const override;
/**
* Returns an input stream containing an empty string.
*/
std::unique_ptr<std::istream> doStream(
const std::string &location) const override;
};
/**
* The NullResourceLocator is used as a fallback for invalid Resources.
*/
extern const NullResourceLocatorImpl NullResourceLocator;
}
#endif /* _RESOURCE_LOCATOR_HPP_ */
|
