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
|
/*
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 ParserStateCallbacks.hpp
*
* Contains an interface defining the callbacks that can be directed from a
* ParserStateHandler to the ParserStateStack, and from the ParserStateStack to
* the actual parser.
*
* @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de)
*/
#ifndef _OUSIA_PARSER_STATE_CALLBACKS_HPP_
#define _OUSIA_PARSER_STATE_CALLBACKS_HPP_
#include <string>
#include <core/common/Whitespace.hpp>
namespace ousia {
/**
* Interface defining a set of callback functions that act as a basis for the
* ParserStateStackCallbacks and the ParserCallbacks.
*/
class ParserStateCallbacks {
public:
/**
* Virtual descructor.
*/
virtual ~ParserStateCallbacks() {};
/**
* Sets the whitespace mode that specifies how string data should be
* processed.
*
* @param whitespaceMode specifies one of the three WhitespaceMode constants
* PRESERVE, TRIM or COLLAPSE.
*/
virtual void setWhitespaceMode(WhitespaceMode whitespaceMode) = 0;
/**
* Sets the type as which the variant data should be parsed.
*
* @param type is one of the VariantType constants, specifying with which
* type the data that is passed to the ParserStateHandler in the "data"
* function should be handled.
*/
virtual void setDataType(VariantType type) = 0;
/**
* Registers the given token as token that should be reported to the handler
* using the "token" function.
*
* @param token is the token string that should be reported.
*/
virtual void registerToken(const std::string &token) = 0;
/**
* Unregisters the given token, it will no longer be reported to the handler
* using the "token" function.
*
* @param token is the token string that should be unregistered.
*/
virtual void unregisterToken(const std::string &token) = 0;
};
/**
* Interface defining the callback functions that can be passed from a
* ParserStateStack to the underlying parser.
*/
class ParserCallbacks : public ParserStateCallbacks {
/**
* Checks whether the given token is supported by the parser. The parser
* returns true, if the token is supported, false if this token cannot be
* registered. Note that parsers that do not support the registration of
* tokens at all should always return "true".
*
* @param token is the token that should be checked for support.
* @return true if the token is generally supported (or the parser does not
* support registering tokens at all), false if the token is not supported,
* because e.g. it is a reserved token or it interferes with other tokens.
*/
virtual bool supportsToken(const std::string &token) = 0;
}
}
#endif /* _OUSIA_PARSER_STATE_CALLBACKS_HPP_ */
|
