simdjson 4.2.0
Ridiculously Fast JSON
Loading...
Searching...
No Matches
parser.h
1#ifndef SIMDJSON_DOM_PARSER_H
2#define SIMDJSON_DOM_PARSER_H
3
4#include "simdjson/dom/base.h"
5#include "simdjson/dom/document.h"
6
7namespace simdjson {
8
9namespace dom {
10
30class parser {
31public:
43 simdjson_inline explicit parser(size_t max_capacity = SIMDJSON_MAXSIZE_BYTES) noexcept;
49 simdjson_inline parser(parser &&other) noexcept;
50 parser(const parser &) = delete;
56 simdjson_inline parser &operator=(parser &&other) noexcept;
57 parser &operator=(const parser &) = delete;
58
60 ~parser()=default;
61
105 inline simdjson_result<element> load(std::string_view path) & noexcept;
106 inline simdjson_result<element> load(std::string_view path) && = delete ;
107
151 inline simdjson_result<element> load_into_document(document& doc, std::string_view path) & noexcept;
152 inline simdjson_result<element> load_into_document(document& doc, std::string_view path) && =delete;
153
237 inline simdjson_result<element> parse(const uint8_t *buf, size_t len, bool realloc_if_needed = true) & noexcept;
238 inline simdjson_result<element> parse(const uint8_t *buf, size_t len, bool realloc_if_needed = true) && =delete;
240 simdjson_inline simdjson_result<element> parse(const char *buf, size_t len, bool realloc_if_needed = true) & noexcept;
241 simdjson_inline simdjson_result<element> parse(const char *buf, size_t len, bool realloc_if_needed = true) && =delete;
243 simdjson_inline simdjson_result<element> parse(const std::string &s) & noexcept;
244 simdjson_inline simdjson_result<element> parse(const std::string &s) && =delete;
246 simdjson_inline simdjson_result<element> parse(const padded_string &s) & noexcept;
247 simdjson_inline simdjson_result<element> parse(const padded_string &s) && =delete;
249 simdjson_inline simdjson_result<element> parse(const padded_string_view &v) & noexcept;
250 simdjson_inline simdjson_result<element> parse(const padded_string_view &v) && =delete;
251
253 simdjson_inline simdjson_result<element> parse(const char *buf) noexcept = delete;
254
299 inline simdjson_result<element> parse_into_document(document& doc, const uint8_t *buf, size_t len, bool realloc_if_needed = true) & noexcept;
300 inline simdjson_result<element> parse_into_document(document& doc, const uint8_t *buf, size_t len, bool realloc_if_needed = true) && =delete;
302 simdjson_inline simdjson_result<element> parse_into_document(document& doc, const char *buf, size_t len, bool realloc_if_needed = true) & noexcept;
303 simdjson_inline simdjson_result<element> parse_into_document(document& doc, const char *buf, size_t len, bool realloc_if_needed = true) && =delete;
305 simdjson_inline simdjson_result<element> parse_into_document(document& doc, const std::string &s) & noexcept;
306 simdjson_inline simdjson_result<element> parse_into_document(document& doc, const std::string &s) && =delete;
308 simdjson_inline simdjson_result<element> parse_into_document(document& doc, const padded_string &s) & noexcept;
309 simdjson_inline simdjson_result<element> parse_into_document(document& doc, const padded_string &s) && =delete;
310
312 simdjson_inline simdjson_result<element> parse_into_document(document& doc, const char *buf) noexcept = delete;
313
389 inline simdjson_result<document_stream> load_many(std::string_view path, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept;
390
487 inline simdjson_result<document_stream> parse_many(const uint8_t *buf, size_t len, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept;
489 inline simdjson_result<document_stream> parse_many(const char *buf, size_t len, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept;
491 inline simdjson_result<document_stream> parse_many(const std::string &s, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept;
492 inline simdjson_result<document_stream> parse_many(const std::string &&s, size_t batch_size) = delete;// unsafe
494 inline simdjson_result<document_stream> parse_many(const padded_string &s, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept;
495 inline simdjson_result<document_stream> parse_many(const padded_string &&s, size_t batch_size) = delete;// unsafe
496
498 simdjson_result<document_stream> parse_many(const char *buf, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept = delete;
499
508 simdjson_warn_unused inline error_code allocate(size_t capacity, size_t max_depth = DEFAULT_MAX_DEPTH) noexcept;
509
510#ifndef SIMDJSON_DISABLE_DEPRECATED_API
522 [[deprecated("Use allocate() instead.")]]
523 simdjson_warn_unused inline bool allocate_capacity(size_t capacity, size_t max_depth = DEFAULT_MAX_DEPTH) noexcept;
524#endif // SIMDJSON_DISABLE_DEPRECATED_API
530 simdjson_inline size_t capacity() const noexcept;
531
539 simdjson_inline size_t max_capacity() const noexcept;
540
546 simdjson_pure simdjson_inline size_t max_depth() const noexcept;
547
562 simdjson_inline void set_max_capacity(size_t max_capacity) noexcept;
563
564#ifdef SIMDJSON_THREADS_ENABLED
570 bool threaded{true};
571#else
575 bool threaded{false};
576#endif
578 class Iterator;
580 using InvalidJSON [[deprecated("Use simdjson_error instead")]] = simdjson_error;
581
583 std::unique_ptr<internal::dom_parser_implementation> implementation{};
584
586 bool valid{false};
589
591 document doc{};
592
594 [[deprecated("Use the result of parser.parse() instead")]]
595 inline bool is_valid() const noexcept;
596
601 [[deprecated("Use the result of parser.parse() instead")]]
602 inline int get_error_code() const noexcept;
603
605 [[deprecated("Use error_message() on the result of parser.parse() instead, or cout << error")]]
606 inline std::string get_error_message() const noexcept;
607
609 [[deprecated("Use cout << on the result of parser.parse() instead")]]
610 inline bool print_json(std::ostream &os) const noexcept;
611
613 inline bool dump_raw_tape(std::ostream &os) const noexcept;
614
615
616private:
622 size_t _max_capacity;
623
627 std::unique_ptr<char[]> loaded_bytes;
628
630 size_t _loaded_bytes_capacity{0};
631
632 // all nodes are stored on the doc.tape using a 64-bit word.
633 //
634 // strings, double and ints are stored as
635 // a 64-bit word with a pointer to the actual value
636 //
637 //
638 //
639 // for objects or arrays, store [ or { at the beginning and } and ] at the
640 // end. For the openings ([ or {), we annotate them with a reference to the
641 // location on the doc.tape of the end, and for then closings (} and ]), we
642 // annotate them with a reference to the location of the opening
643 //
644 //
645
651 inline error_code ensure_capacity(size_t desired_capacity) noexcept;
657 inline error_code ensure_capacity(document& doc, size_t desired_capacity) noexcept;
658
660 inline simdjson_result<size_t> read_file(std::string_view path) noexcept;
661
662 friend class parser::Iterator;
663 friend class document_stream;
664
665
666}; // class parser
667
668} // namespace dom
669} // namespace simdjson
670
671#endif // SIMDJSON_DOM_PARSER_H
A parsed JSON document.
Definition document.h:16
A persistent document parser.
Definition parser.h:30
simdjson_result< element > parse(const uint8_t *buf, size_t len, bool realloc_if_needed=true) &noexcept
Parse a JSON document and return a temporary reference to it.
Definition parser-inl.h:153
simdjson_result< element > parse_into_document(document &doc, const uint8_t *buf, size_t len, bool realloc_if_needed=true) &noexcept
Parse a JSON document into a provide document instance and return a temporary reference to it.
Definition parser-inl.h:113
simdjson_inline parser(parser &&other) noexcept
Take another parser's buffers and state.
simdjson_result< document_stream > parse_many(const uint8_t *buf, size_t len, size_t batch_size=dom::DEFAULT_BATCH_SIZE) noexcept
Parse a buffer containing many JSON documents.
Definition parser-inl.h:170
bool threaded
When SIMDJSON_THREADS_ENABLED is not defined, the parser instance cannot use threads.
Definition parser.h:575
simdjson_inline void set_max_capacity(size_t max_capacity) noexcept
Set max_capacity.
Definition parser-inl.h:247
simdjson_inline size_t max_capacity() const noexcept
The largest document this parser can automatically support.
Definition parser-inl.h:191
simdjson_result< document_stream > load_many(std::string_view path, size_t batch_size=dom::DEFAULT_BATCH_SIZE) noexcept
Load a file containing many JSON documents.
Definition parser-inl.h:105
simdjson_result< element > load_into_document(document &doc, std::string_view path) &noexcept
Load a JSON document from a file into a provide document instance and return a temporary reference to...
Definition parser-inl.h:98
simdjson_pure simdjson_inline size_t max_depth() const noexcept
The maximum level of nested object and arrays supported by this parser.
Definition parser-inl.h:194
simdjson_result< element > load(std::string_view path) &noexcept
Load a JSON document from a file and return a reference to it.
Definition parser-inl.h:94
~parser()=default
Deallocate the JSON parser.
simdjson_inline size_t capacity() const noexcept
The largest document this parser can support without reallocating.
Definition parser-inl.h:188
simdjson_inline parser & operator=(parser &&other) noexcept
Take another parser's buffers and state.
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:199
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
const char * error_message(error_code error) noexcept
It is the convention throughout the code that the macro SIMDJSON_DEVELOPMENT_CHECKS determines whethe...
Definition error-inl.h:25
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
@ UNINITIALIZED
unknown error, or uninitialized document
Definition error.h:32
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()
Exception thrown when an exception-supporting simdjson method is called.
Definition error.h:91
The result of a simdjson operation that could fail.
Definition error.h:278