blob: 54c5bfc4cda7455ad1fa9afbf97a3a7347d859db (
plain)
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
|
/*
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>
namespace ousia {
// Forward declarations
class CharReader;
class ParserContext;
/**
* 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 {
protected:
/**
* 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 reader is a reference to the CharReader that should be used.
* @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 void doParse(CharReader &reader, ParserContext &ctx) = 0;
public:
/**
* Default constructor.
*/
Parser() {}
/**
* No copy construction.
*/
Parser(const Parser &) = delete;
/**
* Virtual destructor.
*/
virtual ~Parser(){};
/**
* Parses the given input stream and returns a corresponding node for
* inclusion in the document graph. This method should be overridden by
* derived classes. The created nodes should be placed onto the ParserScope
* using the "push" methods and removed using the "pop" methods. Nodes
* pushed to the top level of the ParserScope are considered as the subgraph
* the parser has created.
*
* @param reader is a reference to the CharReader that should be used.
* @param ctx is a reference to the context that should be used while
* parsing the document.
*/
void parse(CharReader &reader, ParserContext &ctx);
/**
* Parses the given string and returns a corresponding node for
* inclusion in the document graph. This method should be overridden by
* derived classes. The created nodes should be placed onto the ParserScope
* using the "push" methods and removed using the "pop" methods. Nodes
* pushed to the top level of the ParserScope are considered as the subgraph
* the parser has created.
*
* @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.
*/
void parse(const std::string &str, ParserContext &ctx);
};
}
#endif /* _OUSIA_PARSER_HPP_ */
|
