mirror of https://github.com/nlohmann/json.git synced 2026-10-11 11:25:16 +00:00

Files

Niels Lohmann 759dd2e1b1 Add json_document and json_view: node index, parser, and document

Add json_document and json_view, a read-only, zero-copy index of a
JSON text, as the first public slice of the zero-copy view (#5295).

A parse produces a flat array of 16-byte nodes in document order,
one per value and one per object key. Strings stay in the source
text; escaped strings are decoded into an arena. Integers are
converted while their digits are in the cache; floats keep only
their digit layout and are converted on read. Containers store the
size of their subtree, so a reader can step over one in constant
time. A document makes a handful of allocations, however many
values it has.

The parser accepts exactly what json::parse accepts, with every
combination of ignore_comments and ignore_trailing_commas, with and
without a trailing NUL, and under JSON_STRICT_NUL_HANDLING. It is
portable C++11 and does not depend on byte order.

basic_json_document adds parse, parse_copy, accept, read (reuses a
document's memory), root, is_discarded, source, owns_source,
node_count, memory_usage, and shrink_to_fit. basic_json_view adds
type, the is_* queries, operator bool, size, empty, materialize,
and source_offset. A parse error throws the same exception
basic_json::parse would throw for the same input, message and
position included.

detail::abi_config keeps JSON_STRICT_NUL_HANDLING and
JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON readable after json.hpp
undefines them, in the ABI namespace so they always match the
basic_json in use.

A NUL byte that ends a // comment is the end of the input, as in
parse() since #5696.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

2026-10-07 16:42:22 +02:00

1.7 KiB

Raw Blame History

nlohmann::basic_json_view::source_offset

std::size_t source_offset() const noexcept;

Returns the byte offset of this value in the document's source() text, without materializing anything.

Return value

For a string with no escapes, a number, #!json true/#!json false/#!json null, an array, or an object: the byte offset of the first byte of the value's token (for a string: the first byte after the opening quote) in source().
#!cpp static_cast<std::size_t>(-1) for a discarded view, and for a string that contains escapes -- such a string was decoded once into the document's own buffer, so there is no single byte range in source() left to point at.

Exception safety

No-throw guarantee: this function never throws exceptions.

Complexity

Constant.

Notes

This is a raw offset, not a length: the API does not (yet) expose how many bytes the token occupies in the source text, so source_offset() alone is enough to report where a value came from (for an error message, for syntax highlighting, ...) but not to slice its exact text back out of source() for a string, whose token length is not the same as its decoded size().

Examples

??? example

```cpp
--8<-- "examples/basic_json_view__source_offset.cpp"
```

Output:

```json
--8<-- "examples/basic_json_view__source_offset.output"
```

Version history

Added in version 3.13.0.

1.7 KiB Raw Blame History