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
|
/*
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 Parser.hpp
*
* Contains the abstract Parser class. Parsers are objects capable of reading
* a certain file format and transforming it into a node.
*
* @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de)
*/
#ifndef _OUSIA_PARSER_HPP_
#define _OUSIA_PARSER_HPP_
#include <istream>
#include <set>
#include <string>
#include <core/Node.hpp>
#include <core/Registry.hpp>
#include <core/common/Exceptions.hpp>
#include <core/common/Logger.hpp>
#include "Scope.hpp"
namespace ousia {
namespace parser {
// TODO: Implement a proper Mimetype class
/**
* Exception to be thrown whenever an error occurs inside a specific parser.
*/
class ParserException : public LoggableException {
public:
using LoggableException::LoggableException;
};
/**
* Struct containing the objects that are passed to a parser instance.
*/
struct ParserContext {
/**
* Reference to the Scope instance that should be used within the parser.
*/
Scope &scope;
/**
* Reference to the Registry instance that should be used within the parser.
*/
Registry ®istry;
/**
* Reference to the Logger the parser should log any messages to.
*/
Logger &logger;
/**
* Reference to the Manager the parser should append nodes to.
*/
Manager &manager;
/**
* Constructor of the ParserContext class.
*
* @param scope is a reference to the Scope instance that should be used to
* lookup names.
* @param registry is a reference at the Registry class, which allows to
* obtain references at parsers for other formats or script engine
* implementations.
* @param logger is a reference to the Logger instance that should be used
* to log error messages and warnings that occur while parsing the document.
* @param manager is a Reference to the Manager the parser should append
*nodes to.
*/
ParserContext(Scope &scope, Registry ®istry, Logger &logger,
Manager &manager)
: scope(scope), registry(registry), logger(logger), manager(manager){};
};
struct StandaloneParserContext : public ParserContext {
private:
Logger logger;
Scope scope;
Registry registry;
Manager manager;
public:
StandaloneParserContext()
: ParserContext(scope, registry, logger, manager),
scope(nullptr),
registry(logger){};
};
/**
* Abstract parser class. This class builds the basic interface that should be
* used by any parser which reads data from an input stream and transforms it
* into an Ousía node graph.
*/
class Parser {
public:
Parser(){};
Parser(const Parser &) = delete;
/**
* Returns a set containing all mime types supported by the parser. The mime
* types are used to describe the type of the document that is read by the
* parser. The default implementation returns an empty set. This method
* should be overridden by derived classes.
*
* @return a set containing the string value of the supported mime types.
*/
virtual std::set<std::string> mimetypes()
{
return std::set<std::string>{};
};
/**
* Parses the given input stream and returns a corresponding node for
* inclusion in the document graph. This method should be overridden by
* derived classes.
*
* @param is is a reference to the input stream that should be parsed.
* @param ctx is a reference to the context that should be used while
* parsing the document.
* @return a reference to the node representing the subgraph that has been
* created. The resulting node may point at not yet resolved entities, the
* calling code will try to resolve these. If no valid node can be produced,
* a corresponding LoggableException must be thrown by the parser.
*/
virtual Rooted<Node> parse(std::istream &is, ParserContext &ctx) = 0;
/**
* Parses the given string and returns a corresponding node for
* inclusion in the document graph. This method should be overridden by
* derived classes.
*
* @param str is the string that should be parsed.
* @param ctx is a reference to the context that should be used while
* parsing the document.
* @return a reference to the node representing the subgraph that has been
* created. The resulting node may point at not yet resolved entities, the
* calling code will try to resolve these. If no valid node can be produced,
* a corresponding ParserException must be thrown by the parser.
*/
Rooted<Node> parse(const std::string &str, ParserContext &ctx);
};
}
}
#endif /* _OUSIA_PARSER_HPP_ */
|
