simdjson 4.2.1
Ridiculously Fast JSON
Loading...
Searching...
No Matches
parser.h
1#ifndef SIMDJSON_GENERIC_ONDEMAND_PARSER_H
2
3#ifndef SIMDJSON_CONDITIONAL_INCLUDE
4#define SIMDJSON_GENERIC_ONDEMAND_PARSER_H
5#include "simdjson/generic/ondemand/base.h"
6#include "simdjson/generic/implementation_simdjson_result_base.h"
7#endif // SIMDJSON_CONDITIONAL_INCLUDE
8
9#include <memory>
10#include <thread>
11
12namespace simdjson {
13namespace SIMDJSON_IMPLEMENTATION {
14namespace ondemand {
15
21static constexpr size_t DEFAULT_BATCH_SIZE = 1000000;
30static constexpr size_t MINIMAL_BATCH_SIZE = 32;
31
37class parser {
38public:
44 inline explicit parser(size_t max_capacity = SIMDJSON_MAXSIZE_BYTES) noexcept;
45
46 inline parser(parser &&other) noexcept = default;
47 simdjson_inline parser(const parser &other) = delete;
48 simdjson_inline parser &operator=(const parser &other) = delete;
49 simdjson_inline parser &operator=(parser &&other) noexcept = default;
50
52 inline ~parser() noexcept = default;
53
117 simdjson_warn_unused simdjson_result<document> iterate(padded_string_view json) & noexcept;
118#ifdef SIMDJSON_EXPERIMENTAL_ALLOW_INCOMPLETE_JSON
119 simdjson_warn_unused simdjson_result<document> iterate_allow_incomplete_json(padded_string_view json) & noexcept;
120#endif // SIMDJSON_EXPERIMENTAL_ALLOW_INCOMPLETE_JSON
122 simdjson_warn_unused simdjson_result<document> iterate(const char *json, size_t len, size_t capacity) & noexcept;
124 simdjson_warn_unused simdjson_result<document> iterate(const uint8_t *json, size_t len, size_t capacity) & noexcept;
126 simdjson_warn_unused simdjson_result<document> iterate(std::string_view json, size_t capacity) & noexcept;
128 simdjson_warn_unused simdjson_result<document> iterate(const std::string &json) & noexcept;
132 simdjson_warn_unused simdjson_result<document> iterate(std::string &json) & noexcept;
134 simdjson_warn_unused simdjson_result<document> iterate(const simdjson_result<padded_string> &json) & noexcept;
136 simdjson_warn_unused simdjson_result<document> iterate(const simdjson_result<padded_string_view> &json) & noexcept;
138 simdjson_warn_unused simdjson_result<document> iterate(padded_string &&json) & noexcept = delete;
139
180 simdjson_warn_unused simdjson_result<json_iterator> iterate_raw(padded_string_view json) & noexcept;
181
182
258 inline simdjson_result<document_stream> iterate_many(const uint8_t *buf, size_t len, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
260 inline simdjson_result<document_stream> iterate_many(padded_string_view json, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
262 inline simdjson_result<document_stream> iterate_many(const char *buf, size_t len, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
264 inline simdjson_result<document_stream> iterate_many(const std::string &s, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
267 inline simdjson_result<document_stream> iterate_many(std::string &s, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
269 inline simdjson_result<document_stream> iterate_many(const padded_string &s, size_t batch_size = DEFAULT_BATCH_SIZE, bool allow_comma_separated = false) noexcept;
271 simdjson_result<document_stream> iterate_many(const char *buf, size_t batch_size = DEFAULT_BATCH_SIZE) noexcept = delete;
272
274 simdjson_pure simdjson_inline size_t capacity() const noexcept;
276 simdjson_pure simdjson_inline size_t max_capacity() const noexcept;
277 simdjson_inline void set_max_capacity(size_t max_capacity) noexcept;
284 simdjson_pure simdjson_inline size_t max_depth() const noexcept;
285
298 simdjson_warn_unused error_code allocate(size_t capacity, size_t max_depth=DEFAULT_MAX_DEPTH) noexcept;
299
300 #ifdef SIMDJSON_THREADS_ENABLED
306 bool threaded{true};
307 #else
311 bool threaded{false};
312 #endif
335 simdjson_inline simdjson_result<std::string_view> unescape(raw_json_string in, uint8_t *&dst, bool allow_replacement = false) const noexcept;
336
358 simdjson_inline simdjson_result<std::string_view> unescape_wobbly(raw_json_string in, uint8_t *&dst) const noexcept;
359
360#if SIMDJSON_DEVELOPMENT_CHECKS
368 bool string_buffer_overflow(const uint8_t *string_buf_loc) const noexcept;
369#endif
370
382 static simdjson_inline simdjson_warn_unused ondemand::parser& get_parser();
388 static simdjson_inline bool release_parser();
389
390private:
391 friend bool release_parser();
392 friend ondemand::parser& get_parser();
394 static simdjson_inline simdjson_warn_unused std::unique_ptr<ondemand::parser>& get_parser_instance();
396 static simdjson_inline simdjson_warn_unused std::unique_ptr<ondemand::parser>& get_threadlocal_parser_if_exists();
398 std::unique_ptr<simdjson::internal::dom_parser_implementation> implementation{};
399 size_t _capacity{0};
400 size_t _max_capacity;
401 size_t _max_depth{DEFAULT_MAX_DEPTH};
402 std::unique_ptr<uint8_t[]> string_buf{};
403
404#if SIMDJSON_DEVELOPMENT_CHECKS
405 std::unique_ptr<token_position[]> start_positions{};
406#endif
407
408 friend class json_iterator;
409 friend class document_stream;
410};
411
412} // namespace ondemand
413} // namespace SIMDJSON_IMPLEMENTATION
414} // namespace simdjson
415
416namespace simdjson {
417
418template<>
419struct simdjson_result<SIMDJSON_IMPLEMENTATION::ondemand::parser> : public SIMDJSON_IMPLEMENTATION::implementation_simdjson_result_base<SIMDJSON_IMPLEMENTATION::ondemand::parser> {
420public:
421 simdjson_inline simdjson_result(SIMDJSON_IMPLEMENTATION::ondemand::parser &&value) noexcept;
422 simdjson_inline simdjson_result(error_code error) noexcept;
423 simdjson_inline simdjson_result() noexcept = default;
424};
425
426} // namespace simdjson
427
428#endif // SIMDJSON_GENERIC_ONDEMAND_PARSER_H
simdjson_warn_unused simdjson_result< document > iterate(padded_string_view json) &noexcept
Start iterating an on-demand JSON document.
Definition parser-inl.h:51
static simdjson_inline bool release_parser()
Release the parser instance initialized by get_parser() and all the associated resources (memory).
simdjson_pure simdjson_inline size_t max_capacity() const noexcept
The maximum capacity of this parser (the largest document it is allowed to process).
Definition parser-inl.h:167
simdjson_inline simdjson_result< std::string_view > unescape(raw_json_string in, uint8_t *&dst, bool allow_replacement=false) const noexcept
Unescape this JSON string, replacing \ with \, with newline, etc.
Definition parser-inl.h:182
~parser() noexcept=default
Deallocate the JSON parser.
simdjson_pure simdjson_inline size_t max_depth() const noexcept
The maximum depth of this parser (the most deeply nested objects and arrays it can process).
Definition parser-inl.h:170
simdjson_pure simdjson_inline size_t capacity() const noexcept
The capacity of this parser (the largest document it can process).
Definition parser-inl.h:164
simdjson_inline simdjson_result< std::string_view > unescape_wobbly(raw_json_string in, uint8_t *&dst) const noexcept
Unescape this JSON string, replacing \ with \, with newline, etc.
Definition parser-inl.h:190
bool threaded
When SIMDJSON_THREADS_ENABLED is not defined, the parser instance cannot use threads.
Definition parser.h:311
simdjson_warn_unused error_code allocate(size_t capacity, size_t max_depth=DEFAULT_MAX_DEPTH) noexcept
Ensure this parser has enough memory to process JSON documents up to capacity bytes in length and max...
Definition parser-inl.h:24
static simdjson_inline simdjson_warn_unused ondemand::parser & get_parser()
Get a unique parser instance corresponding to the current thread.
Definition parser-inl.h:198
simdjson_result< document_stream > iterate_many(const uint8_t *buf, size_t len, size_t batch_size=DEFAULT_BATCH_SIZE, bool allow_comma_separated=false) noexcept
Parse a buffer containing many JSON documents.
Definition parser-inl.h:136
A string escaped per JSON rules, terminated with quote (").
An implementation of simdjson for a particular CPU architecture.
User-provided string that promises it has extra padded bytes at the end for use with parser::parse().
The top level simdjson namespace, containing everything the library provides.
Definition base.h:8
constexpr size_t DEFAULT_MAX_DEPTH
By default, simdjson supports this many nested objects and arrays.
Definition base.h:40
error_code
All possible errors returned by simdjson.
Definition error.h:19
SIMDJSON_PUSH_DISABLE_UNUSED_WARNINGS constexpr size_t SIMDJSON_MAXSIZE_BYTES
The maximum document size supported by simdjson.
Definition base.h:23
String with extra allocation for ease of use with parser::parse()
The result of a simdjson operation that could fail.
Definition error.h:278
simdjson_inline error_code error() const noexcept
The error.
Definition error-inl.h:168