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
|
/*
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/>.
*/
/**
* @file ResourceManager.hpp
*
* Defines the ResourceManager class which is responsible for keeping track of
* already included resources and to retrieve CharReader instance for not-yet
* parsed resources.
*
* @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de)
*/
#ifndef _OUSIA_RESOURCE_MANAGER_HPP_
#define _OUSIA_RESOURCE_MANAGER_HPP_
#include <string>
#include <unordered_map>
#include <core/common/Location.hpp>
#include <core/managed/Managed.hpp>
#include "Resource.hpp"
namespace ousia {
// Forward declarations
class Node;
class ParserContext;
class RttiSet;
extern const Resource NullResource;
/**
* The ResourceManager class is responsible for keepking track of all included
* resources. It retrieves CharReader instances for not-yet parsed resources
* and returns references for those resources that already have been parsed.
*/
class ResourceManager {
private:
/**
* Next SourceId to be used.
*/
SourceId nextSourceId = 0;
/**
* Map between Resource locations and the corresponding SourceId.
*/
std::unordered_map<std::string, SourceId> locations;
/**
* Map used for mapping SourceId instances to the underlying resource.
*/
std::unordered_map<SourceId, Resource> resources;
/**
* Map between a SourceId and the corresponding (if available) parsed node
* uid (this resembles weak references to the Node instance).
*/
std::unordered_map<SourceId, ManagedUid> nodes;
/**
* Cache used for translating byte offsets to line numbers. Maps from a
* SourceId onto a list of (sorted) SourceOffsets. The index in the list
* corresponds to the line number.
*/
std::unordered_map<SourceId, std::vector<SourceOffset>> lineNumberCache;
/**
* Allocates a new SourceId for the given resource.
*
* @param resource is the Resource that should be associated with the newly
* allocated SourceId.
* @return a new SourceId describing the given resource.
*/
SourceId allocateSourceId(const Resource &resource);
/**
* Registers the parsed node for this node id.
*
* @param sourceId is SourceId instance of the resource.
* @param node is the node that was parsed from that resource.
*/
void storeNode(SourceId sourceId, Handle<Node> node);
/**
* Removes a resource from the internal stores.
*
* @param sourceId is the id of the file that should be removed.
*/
void purgeResource(SourceId sourceId);
/**
* Used internally to parse the given resource.
*
* @param ctx is the context from the Registry and the Logger instance will
* be looked up.
* @param resource is the resource from which the input stream should be
* obtained.
* @param mimetype is the mimetype of the resource that should be parsed
* (may be empty, in which case the mimetype is deduced from the file
* extension)
* @param supportedTypes contains the types of the returned Node the caller
* can deal with. Note that only the types the parser claims to return are
* checked, not the actual result.
* @return the parsed node or nullptr if something goes wrong.
*/
Rooted<Node> parse(ParserContext &ctx, Resource &resource,
const std::string &mimetype,
const RttiSet &supportedTypes);
public:
/**
* Returns the sourceId for the given location string.
*
* @param location is the location string for which the resource id should
* be returned.
* @return the SourceId that can be used to identify the Resource, or
* InvalidSourceId if the specified location is not loaded.
*/
SourceId getSourceId(const std::string &location);
/**
* Returns the sourceId for the given Resource.
*
* @param resource is the Resource for which the sourceId should be
* returned.
* @return the SourceId that can be used to identify the Resource, or
* InvalidSourceId if the specified resource is not loaded or invalid.
*/
SourceId getSourceId(const Resource &resource);
/**
* Returns a Resource instance for the given SourceId.
*
* @param sourceId is the id of the Resource instance that should be
* returned.
* @return the Resource instance corresponding to the given sourceId. If the
* sourceId is invalid, the returned Resource will be invalid (a reference
* at NullResource).
*/
const Resource &getResource(SourceId sourceId) const;
/**
* Returns the node that is associated with the given SourceId or nullptr if
* the Node no longer exists or the supplied SourceId is invalid.
*
* @param mgr is the Manager instance that should be used to resolve the
* internal weak reference to the Node instance.
* @param sourceId is the id of the resource for which the parsed Node
* instance should be returned.
* @return the Node instance corresponding to the given sourceId.
*/
Rooted<Node> getNode(Manager &mgr, SourceId sourceId);
/**
* Returns the node that is associated with the given location or nullptr if
* the Node no longer exists or the supplied location was never parsed.
*
* @param mgr is the Manager instance that should be used to resolve the
* internal weak reference to the Node instance.
* @param location is the location from which the node was parsed.
* @return the Node instance corresponding to the given location.
*/
Rooted<Node> getNode(Manager &mgr, const std::string &location);
/**
* Returns the node that is associated with the given resource or nullptr if
* the Node no longer exists or the supplied resource was never parsed.
*
* @param mgr is the Manager instance that should be used to resolve the
* internal weak reference to the Node instance.
* @param resource is the resource from which the node was parsed.
* @return the Node instance corresponding to the given resource.
*/
Rooted<Node> getNode(Manager &mgr, const Resource &resource);
/**
* Resolves the reference to the file specified by the given path and -- if
* this has not already happened -- parses the file. Logs any problem in
* the logger instance of the given ParserContext.
*
* @param ctx is the context from the Registry and the Logger instance will
* be looked up.
* @param path is the path to the file that should be included.
* @param mimetype is the mimetype the file was included with. If no
* mimetype is given, the path must have an extension that is known by
*/
Rooted<Node> link(ParserContext &ctx, const std::string &path,
const std::string &mimetype = "",
const std::string &rel = "",
const RttiSet &supportedTypes = RttiSet{},
const Resource &relativeTo = NullResource);
/**
* Resolves the reference to the file specified by the given path and -- if
* this has not already happened -- parses the file. Logs any problem in
* the logger instance of the given ParserContext.
*/
Rooted<Node> link(ParserContext &ctx, const std::string &path,
const std::string &mimetype, const std::string &rel,
const RttiSet &supportedTypes, SourceId relativeTo);
/**
* Creates and returns a SourceContext structure containing information
* about the given SourceLocation (such as line and column number). Throws
* a LoggableException if an irrecoverable error occurs while looking up the
* context (such as a no longer existing resource).
*
* @param location is the SourceLocation for which context information
* should be retrieved. This method is used by the Logger class to print
* pretty messages.
* @return a valid SourceContext if a valid SourceLocation was given or an
* invalid SourceContext if the location is invalid.
*/
SourceContext buildContext(const SourceLocation &location);
};
}
#endif /* _OUSIA_RESOURCE_MANAGER_HPP_ */
|
