summaryrefslogtreecommitdiffhomepage
path: root/vendor/toml++/impl/parser.hpp
blob: 281efbcca282ef1786ef01ed5487bbc3c406f7e4 (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
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
// # This file is a part of toml++ and is subject to the the terms of the MIT license.
// # Copyright (c) Mark Gillard <mark.gillard@outlook.com.au>
// # See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text.
//  SPDX-License-Identifier: MIT
#pragma once

#include "preprocessor.hpp"
#if TOML_ENABLE_PARSER

#include "header_start.hpp"
#include "parse_result.hpp"
#include "table.hpp"

TOML_NAMESPACE_START {
  TOML_ABI_NAMESPACE_BOOL(TOML_EXCEPTIONS, ex, noex);

  /// \brief	Parses a TOML document from a string view.
  ///
  /// \detail \cpp
  /// auto tbl = toml::parse("a = 3"sv);
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::string_view doc, std::string_view source_path = {});

  /// \brief	Parses a TOML document from a string view.
  ///
  /// \detail \cpp
  /// auto tbl = toml::parse("a = 3"sv, "foo.toml");
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::string_view doc, std::string && source_path);

  /// \brief	Parses a TOML document from a file.
  ///
  /// \detail \cpp
  /// toml::parse_result get_foo_toml()
  /// {
  ///		return toml::parse_file("foo.toml");
  /// }
  /// \ecpp
  ///
  /// \param 	file_path		The TOML document to parse. Must be valid UTF-8.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse_file(std::string_view file_path);

#if TOML_HAS_CHAR8

  /// \brief	Parses a TOML document from a char8_t string view.
  ///
  /// \detail \cpp
  /// auto tbl = toml::parse(u8"a = 3"sv);
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::u8string_view doc, std::string_view source_path = {});

  /// \brief	Parses a TOML document from a char8_t string view.
  ///
  /// \detail \cpp
  /// auto tbl = toml::parse(u8"a = 3"sv, "foo.toml");
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::u8string_view doc, std::string && source_path);

  /// \brief	Parses a TOML document from a file.
  ///
  /// \detail \cpp
  /// toml::parse_result get_foo_toml()
  /// {
  ///		return toml::parse_file(u8"foo.toml");
  /// }
  /// \ecpp
  ///
  /// \param 	file_path		The TOML document to parse. Must be valid UTF-8.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse_file(std::u8string_view file_path);

#endif  // TOML_HAS_CHAR8

#if TOML_ENABLE_WINDOWS_COMPAT

  /// \brief	Parses a TOML document from a string view.
  ///
  /// \availability This overload is only available when #TOML_ENABLE_WINDOWS_COMPAT is enabled.
  ///
  /// \detail \cpp
  /// auto tbl = toml::parse("a = 3"sv, L"foo.toml");
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::string_view doc, std::wstring_view source_path);

  /// \brief	Parses a TOML document from a stream.
  ///
  /// \availability This overload is only available when #TOML_ENABLE_WINDOWS_COMPAT is enabled.
  ///
  /// \detail \cpp
  /// std::stringstream ss;
  /// ss << "a = 3"sv;
  ///
  /// auto tbl = toml::parse(ss);
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::istream & doc, std::wstring_view source_path);

  /// \brief	Parses a TOML document from a file.
  ///
  /// \availability This overload is only available when #TOML_ENABLE_WINDOWS_COMPAT is enabled.
  ///
  /// \detail \cpp
  /// toml::parse_result get_foo_toml()
  /// {
  ///		return toml::parse_file(L"foo.toml");
  /// }
  /// \ecpp
  ///
  /// \param 	file_path		The TOML document to parse. Must be valid UTF-8.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse_file(std::wstring_view file_path);

#endif  // TOML_ENABLE_WINDOWS_COMPAT

#if TOML_HAS_CHAR8 && TOML_ENABLE_WINDOWS_COMPAT

  /// \brief	Parses a TOML document from a char8_t string view.
  ///
  /// \availability This overload is only available when #TOML_ENABLE_WINDOWS_COMPAT is enabled.
  ///
  /// \detail \cpp
  /// auto tbl = toml::parse(u8"a = 3"sv, L"foo.toml");
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::u8string_view doc, std::wstring_view source_path);

#endif  // TOML_HAS_CHAR8 && TOML_ENABLE_WINDOWS_COMPAT

  /// \brief	Parses a TOML document from a stream.
  ///
  /// \detail \cpp
  /// std::stringstream ss;
  /// ss << "a = 3"sv;
  ///
  /// auto tbl = toml::parse(ss);
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::istream & doc, std::string_view source_path = {});

  /// \brief	Parses a TOML document from a stream.
  ///
  /// \detail \cpp
  /// std::stringstream ss;
  /// ss << "a = 3"sv;
  ///
  /// auto tbl = toml::parse(ss, "foo.toml");
  /// std::cout << tbl["a"] << "\n";
  /// \ecpp
  ///
  /// \out
  /// 3
  /// \eout
  ///
  /// \param 	doc				The TOML document to parse. Must be valid UTF-8.
  /// \param 	source_path		The path used to initialize each node's `source().path`.
  /// 						If you don't have a path (or you have no intention of using paths in diagnostics)
  /// 						then this parameter can safely be left blank.
  ///
  /// \returns	\conditional_return{With exceptions}
  ///				A toml::table.
  /// 			\conditional_return{Without exceptions}
  ///				A toml::parse_result.
  TOML_NODISCARD
  TOML_EXPORTED_FREE_FUNCTION
  parse_result TOML_CALLCONV parse(std::istream & doc, std::string && source_path);

  TOML_ABI_NAMESPACE_END;  // TOML_EXCEPTIONS

  inline namespace literals {
    TOML_ABI_NAMESPACE_BOOL(TOML_EXCEPTIONS, lit_ex, lit_noex);

    /// \brief	Parses TOML data from a string literal.
    ///
    /// \detail \cpp
    /// using namespace toml::literals;
    ///
    /// auto tbl = "a = 3"_toml;
    /// std::cout << tbl["a"] << "\n";
    /// \ecpp
    ///
    /// \out
    /// 3
    /// \eout
    ///
    /// \param 	str	The string data. Must be valid UTF-8.
    /// \param 	len	The string length.
    ///
    /// \returns	\conditional_return{With exceptions}
    ///				A toml::table.
    /// 			\conditional_return{Without exceptions}
    ///				A toml::parse_result.
    TOML_NODISCARD
    TOML_ALWAYS_INLINE
    parse_result operator"" _toml(const char* str, size_t len) {
      return parse(std::string_view{str, len});
    }

#if TOML_HAS_CHAR8

    /// \brief	Parses TOML data from a UTF-8 string literal.
    ///
    /// \detail \cpp
    /// using namespace toml::literals;
    ///
    /// auto tbl = u8"a = 3"_toml;
    /// std::cout << tbl["a"] << "\n";
    /// \ecpp
    ///
    /// \out
    /// 3
    /// \eout
    ///
    /// \param 	str	The string data. Must be valid UTF-8.
    /// \param 	len	The string length.
    ///
    /// \returns	\conditional_return{With exceptions}
    ///				A toml::table.
    /// 			\conditional_return{Without exceptions}
    ///				A toml::parse_result.
    TOML_NODISCARD
    TOML_ALWAYS_INLINE
    parse_result operator"" _toml(const char8_t* str, size_t len) {
      return parse(std::u8string_view{str, len});
    }

#endif  // TOML_HAS_CHAR8

    TOML_ABI_NAMESPACE_END;  // TOML_EXCEPTIONS
  }  // namespace literals
}
TOML_NAMESPACE_END;

#include "header_end.hpp"
#endif  // TOML_ENABLE_PARSER