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 VariantReader.hpp
*
* Provides parsers for various micro formats. These formats include integers,
* doubles, strings, JSON and the Ousía struct notation.
*
* @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de)
*/
#ifndef _OUSIA_VARIANT_READER_HPP_
#define _OUSIA_VARIANT_READER_HPP_
#include <cstdint>
#include <unordered_set>
#include <utility>
#include "CharReader.hpp"
#include "Logger.hpp"
#include "Variant.hpp"
namespace ousia {
class VariantReader {
private:
/**
* Parses a string which may either be enclosed by " or ', unescapes
* entities in the string as specified for JavaScript.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned after
* the terminating quote character or at the terminating delimiting
* character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
* @param delims is an optional set of delimiters after which parsing has to
* be stopped (the delimiters may occur inside the actual string, but not
* outside). If nullptr is given, no delimiter is used and a complete string
* is read.
*/
static std::pair<bool, std::string> parseString(
CharReader &reader, Logger &logger,
const std::unordered_set<char> *delims);
public:
/**
* Parses a string which may either be enclosed by " or ', unescapes
* entities in the string as specified for JavaScript.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned after
* the terminating quote character or at the terminating delimiting
* character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
* @param delims is a set of delimiters after which parsing has to
* be stopped (the delimiters may occur inside the actual string, but not
* outside).
*/
static std::pair<bool, std::string> parseString(
CharReader &reader, Logger &logger,
const std::unordered_set<char> &delims)
{
return parseString(reader, logger, &delims);
}
/**
* Parses a string which may either be enclosed by " or ', unescapes
* entities in the string as specified for JavaScript.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned after
* the terminating quote character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
*/
static std::pair<bool, std::string> parseString(CharReader &reader,
Logger &logger)
{
return parseString(reader, logger, nullptr);
}
/**
* Extracts a single token from the given CharReader instance. Skips any
* whitespace character until a non-whitespace character is reached. Stops
* if another whitespace character is read or one of the given delimiters
* characters is reached.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned at the
* terminating delimiting character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
* @param delims is a set of characters which will terminate the string.
* These characters are not included in the result.
*/
static std::pair<bool, std::string> parseToken(
CharReader &reader, Logger &logger,
const std::unordered_set<char> &delims);
/**
* Extracts an unescaped string from the given CharReader instance. Skips
* any whitespace character one of the given delimiters is reached. Strips
* whitespace at the end of the string.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned at the
* terminating delimiting character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
* @param delims is a set of characters which will terminate the string.
* These characters are not included in the result.
*/
static std::pair<bool, std::string> parseUnescapedString(
CharReader &reader, Logger &logger,
const std::unordered_set<char> &delims);
/**
* Parses an integer from the given CharReader instance until one of the
* given delimiter characters is reached.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned after
* the number or at the terminating delimiting character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
* @param delims is a set of characters which will terminate the integer.
* These characters are not included in the result.
*/
static std::pair<bool, int64_t> parseInteger(
CharReader &reader, Logger &logger,
const std::unordered_set<char> &delims);
/**
* Parses an double from the given CharReader instance until one of the
* given delimiter characters is reached.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned after
* the number or at the terminating delimiting character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
* @param delims is a set of characters which will terminate the double.
* These characters are not included in the result.
*/
static std::pair<bool, double> parseDouble(
CharReader &reader, Logger &logger,
const std::unordered_set<char> &delims);
/**
* Parses an array of values.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned after
* the number or at the terminating delimiting character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
* @param delim is the terminating character. If nonzero, the parse function
* assumes that it is already inside the array and will not wait for a '['
* character.
*/
static std::pair<bool, Variant::arrayType> parseArray(
CharReader &reader, Logger &logger, char delim = 0);
/**
* Parses an object definition.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned after
* the number or at the terminating delimiting character.
* @param logger is the logger instance that should be used to log error
* messages and warnings.
* @param delim is the terminating character. If nonzero, the parse function
* assumes that it is already inside the array and will not wait for a '['
* character.
*/
static std::pair<bool, Variant::mapType> parseObject(
CharReader &reader, Logger &logger, char delim = 0);
/**
* Tries to parse the most specific item from the given stream until one of
* the given delimiters is reached or a meaningful literal (possibly an
* array of literals) has been read. The resulting variant represents the
* value that has been read.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned
* at the terminating delimiting character.
* @param delims is a set of characters which will terminate the string.
* These characters are not included in the result. May not be nullptr.
*/
static std::pair<bool, Variant> parseGeneric(
CharReader &reader, Logger &logger,
const std::unordered_set<char> &delims);
/**
* Tries to parse the most specific item from the given stream until one of
* the given delimiters is reached or a meaningful literal has been read.
* The resulting variant represents the value that has been read.
*
* @param reader is a reference to the CharReader instance which is
* the source for the character data. The reader will be positioned
* at the terminating delimiting character.
* @param delims is a set of characters which will terminate the string.
* These characters are not included in the result. May not be nullptr.
* @param extractUnescapedStrings if set to true, interprets non-primitive
* literals as unescaped strings, which may also contain whitespace
* characters. Otherwise string literals are only generated until the next
* whitespace character.
*/
static std::pair<bool, Variant> parseGenericToken(
CharReader &reader, Logger &logger,
const std::unordered_set<char> &delims,
bool extractUnescapedStrings = false);
};
}
#endif /* _OUSIA_VARIANT_READER_HPP_ */
|
