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
|
/*
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 Project.hpp
*
* Contains the concept of the "Project" class which represents the entity into
* which domains, documents, typesystems and other resources are embedded.
*
* @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de)
*/
#ifndef _OUSIA_PROJECT_HPP_
#define _OUSIA_PROJECT_HPP_
#include <core/resource/ResourceManager.hpp>
#include "Node.hpp"
namespace ousia {
// Forward declarations
class Logger;
class Rtti;
class Registry;
class ParserContext;
class SystemTypesystem;
class Typesystem;
class Document;
class Domain;
/**
* The Project class constitutes the top-level node in which a collection of
* documents are stored. It also contains an instance of the SystemTypesystem
* and allows for simple creation of new Typesystem and Domain instances.
*/
class Project : public Node {
private:
/**
* Reference at the internally used Registry instance.
*/
Registry ®istry;
/**
* Private instance of the system typesystem which is distributed as a
* reference to all child typesystems.
*/
Owned<SystemTypesystem> systemTypesystem;
/**
* List containing all loaded documents.
*/
NodeVector<Document> documents;
/**
* ResourceManager used to manage all resources used by the project.
*/
ResourceManager resourceManager;
protected:
/**
* Validates the project and all parts it consists of.
*
* @param logger is the logger instance to which errors will be logged.
*/
bool doValidate(Logger &loger) const override;
public:
/**
* Constructor of the Project class.
*
* @param mgr is the manager instance used for managing this Node.
* @param registry is the registry instance that should be used for locating
* files and finding parsers for these files.
*/
Project(Manager &mgr, Registry ®istry);
/**
* Parses a file with the given Logger in an empty ParserScope. This
* function is meant to be called by the top-level (e.g. a main function)
* and not by other parsers. These should use the link and include methods
* instead.
*
* @param path is the path of the file that should be parsed.
* @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 rel is a "relation string" supplied by the user which specifies
* the relationship of the specified resource. May be empty, in which case
* the relation is deduced from the supported types and the types of the
* parser for the given mimetype.
* @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.
* @param logger is the logger that should be used
* @return the parsed node or nullptr if something goes wrong.
*/
Rooted<Node> parse(const std::string &path, const std::string mimetype,
const std::string rel, RttiSet &supportedTypes,
Logger &logger);
/**
* Parses a file with ParserContext and an empty ParserScope. The parsed
* object graph of files that are parsed using the "link" function is
* cached (in contrast to the "include" function).
*
* @param ctx is the ParserContext that should be passed to the underlying
* parser. The scope in the ParserContext will be exchanged.
* @param path is the path of the file that should be parsed.
* @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 rel is a "relation string" supplied by the user which specifies
* the relationship of the specified resource. May be empty, in which case
* the relation is deduced from the supported types and the types of the
* parser for the given mimetype.
* @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> link(ParserContext &ctx, const std::string &path,
const std::string mimetype, const std::string rel,
RttiSet &supportedTypes);
/**
* Parses a file with ParserContext and the current ParserScope. In contrast
* to the "link" function, include() does not cache the parsed node (as it
* depends on the current ParserScope).
*
* @param ctx is the ParserContext that should be passed to the underlying
* parser. The scope in the ParserContext will be exchanged.
* @param path is the path of the file that should be parsed.
* @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 rel is a "relation string" supplied by the user which specifies
* the relationship of the specified resource. May be empty, in which case
* the relation is deduced from the supported types and the types of the
* parser for the given mimetype.
* @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> include(ParserContext &ctx, const std::string &path,
const std::string mimetype, const std::string rel,
RttiSet &supportedTypes);
/**
* Returns a reference to the internal system typesystem.
*
* @return a reference to the system typesystem.
*/
Rooted<SystemTypesystem> getSystemTypesystem();
/**
* Returns a new typesystem with the given name adds it to the list of
* typesystems. Provides a reference of the system typesystem to the
* typesystem.
*
* @param name is the name of the typesystem that should be created.
*/
Rooted<Typesystem> createTypesystem(const std::string &name);
/**
* Returns a new document with the given name and adds it to the list of
* documents.
*
* @param name is the name of the document that should be created.
*/
Rooted<Document> createDocument(const std::string &name);
/**
* Returns a new domain with the given name and adds it to the list of
* domains. Provides a reference of the system typesystem to the domain.
*
* @param name is the name of the domain that should be created.
*/
Rooted<Domain> createDomain(const std::string &name);
/**
* Adds the given document to the list of documents in the project.
*
* @param document is the document that should be added to the project.
*/
void addDocument(Handle<Document> document);
/**
* Returns all documents of this project.
*
* @return a reference pointing at the document list.
*/
const NodeVector<Document> &getDocuments() const;
};
namespace RttiTypes {
/**
* Type information of the Project class.
*/
extern const Rtti Project;
}
}
#endif /* _OUSIA_PROJECT_HPP_ */
|
