mirror of
https://github.com/nlohmann/json.git
synced 2026-10-04 13:40:33 +00:00
Compare commits
9
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3f672f036d | ||
|
|
83302ff69d | ||
|
|
6a757ca675 | ||
|
|
9d44e3f359 | ||
|
|
9d88ead578 | ||
|
|
f1014c938a | ||
|
|
e91fdad877 | ||
|
|
9c71689715 | ||
|
|
44ec53c77b |
@@ -1,9 +1,18 @@
|
|||||||
|
# bugprone-use-after-move (hicpp-invalid-access-moved is its alias) still flags
|
||||||
|
# the basic_json move constructor, which forwards the whole object to its base
|
||||||
|
# class (#5724), and two forwards in the error-message construction of
|
||||||
|
# at(KeyType&&) (json.hpp, both overloads: find(std::forward<KeyType>(key))
|
||||||
|
# followed by string_t(std::forward<KeyType>(key)) in the throw), which #5689
|
||||||
|
# rewrites. Re-enable both checks once those changes have landed.
|
||||||
# portability-avoid-pragma-once: kept disabled on purpose. #pragma once is accepted
|
# portability-avoid-pragma-once: kept disabled on purpose. #pragma once is accepted
|
||||||
# by every supported compiler, and tools/amalgamate/amalgamate.py strips it from
|
# by every supported compiler, and tools/amalgamate/amalgamate.py strips it from
|
||||||
# single_include, so there is nothing left to fix here.
|
# single_include, so there is nothing left to fix here.
|
||||||
|
|
||||||
Checks: '*,
|
Checks: '*,
|
||||||
|
|
||||||
|
-bugprone-use-after-move,
|
||||||
|
-hicpp-invalid-access-moved,
|
||||||
|
|
||||||
-altera-id-dependent-backward-branch,
|
-altera-id-dependent-backward-branch,
|
||||||
-altera-struct-pack-align,
|
-altera-struct-pack-align,
|
||||||
-altera-unroll-loops,
|
-altera-unroll-loops,
|
||||||
|
|||||||
+1
-1
@@ -53,11 +53,11 @@ cc_library(
|
|||||||
"include/nlohmann/detail/meta/detected.hpp",
|
"include/nlohmann/detail/meta/detected.hpp",
|
||||||
"include/nlohmann/detail/meta/identity_tag.hpp",
|
"include/nlohmann/detail/meta/identity_tag.hpp",
|
||||||
"include/nlohmann/detail/meta/is_sax.hpp",
|
"include/nlohmann/detail/meta/is_sax.hpp",
|
||||||
|
"include/nlohmann/detail/meta/logic.hpp",
|
||||||
"include/nlohmann/detail/meta/std_fs.hpp",
|
"include/nlohmann/detail/meta/std_fs.hpp",
|
||||||
"include/nlohmann/detail/meta/type_traits.hpp",
|
"include/nlohmann/detail/meta/type_traits.hpp",
|
||||||
"include/nlohmann/detail/meta/void_t.hpp",
|
"include/nlohmann/detail/meta/void_t.hpp",
|
||||||
"include/nlohmann/detail/output/binary_writer.hpp",
|
"include/nlohmann/detail/output/binary_writer.hpp",
|
||||||
"include/nlohmann/detail/output/error_handler.hpp",
|
|
||||||
"include/nlohmann/detail/output/output_adapters.hpp",
|
"include/nlohmann/detail/output/output_adapters.hpp",
|
||||||
"include/nlohmann/detail/output/serializer.hpp",
|
"include/nlohmann/detail/output/serializer.hpp",
|
||||||
"include/nlohmann/detail/recursion_depth_limit.hpp",
|
"include/nlohmann/detail/recursion_depth_limit.hpp",
|
||||||
|
|||||||
@@ -61,7 +61,6 @@ option(JSON_Install "Install CMake targets during install
|
|||||||
option(JSON_MultipleHeaders "Use non-amalgamated version of the library." ON)
|
option(JSON_MultipleHeaders "Use non-amalgamated version of the library." ON)
|
||||||
option(JSON_SystemInclude "Include as system headers (skip for clang-tidy)." OFF)
|
option(JSON_SystemInclude "Include as system headers (skip for clang-tidy)." OFF)
|
||||||
option(JSON_StrictNulHandling "Build with strict NUL-byte handling enabled." OFF)
|
option(JSON_StrictNulHandling "Build with strict NUL-byte handling enabled." OFF)
|
||||||
option(JSON_StrictBinaryUTF8 "Build with UTF-8 checks in the CBOR, UBJSON, BJData, and BSON writers enabled." OFF)
|
|
||||||
|
|
||||||
if (JSON_CI)
|
if (JSON_CI)
|
||||||
include(ci)
|
include(ci)
|
||||||
@@ -119,10 +118,6 @@ if (JSON_StrictNulHandling)
|
|||||||
message(STATUS "Strict NUL-byte handling enabled (JSON_STRICT_NUL_HANDLING=1)")
|
message(STATUS "Strict NUL-byte handling enabled (JSON_STRICT_NUL_HANDLING=1)")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
if (JSON_StrictBinaryUTF8)
|
|
||||||
message(STATUS "Strict UTF-8 checks in binary writers enabled (JSON_STRICT_BINARY_UTF8=1)")
|
|
||||||
endif()
|
|
||||||
|
|
||||||
if (JSON_Diagnostic_Positions)
|
if (JSON_Diagnostic_Positions)
|
||||||
message(STATUS "Diagnostic positions enabled (JSON_DIAGNOSTIC_POSITIONS=1)")
|
message(STATUS "Diagnostic positions enabled (JSON_DIAGNOSTIC_POSITIONS=1)")
|
||||||
endif()
|
endif()
|
||||||
@@ -158,7 +153,6 @@ target_compile_definitions(
|
|||||||
$<$<BOOL:${JSON_Diagnostic_Positions}>:JSON_DIAGNOSTIC_POSITIONS=1>
|
$<$<BOOL:${JSON_Diagnostic_Positions}>:JSON_DIAGNOSTIC_POSITIONS=1>
|
||||||
$<$<BOOL:${JSON_LegacyDiscardedValueComparison}>:JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON=1>
|
$<$<BOOL:${JSON_LegacyDiscardedValueComparison}>:JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON=1>
|
||||||
$<$<BOOL:${JSON_StrictNulHandling}>:JSON_STRICT_NUL_HANDLING=1>
|
$<$<BOOL:${JSON_StrictNulHandling}>:JSON_STRICT_NUL_HANDLING=1>
|
||||||
$<$<BOOL:${JSON_StrictBinaryUTF8}>:JSON_STRICT_BINARY_UTF8=1>
|
|
||||||
)
|
)
|
||||||
|
|
||||||
target_include_directories(
|
target_include_directories(
|
||||||
|
|||||||
@@ -1393,7 +1393,7 @@ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR I
|
|||||||
- The class contains a slightly modified version of the Grisu2 algorithm from Florian Loitsch which is licensed under the [MIT License](https://opensource.org/licenses/MIT) (see above). Copyright © 2009 [Florian Loitsch](https://florian.loitsch.com/)
|
- The class contains a slightly modified version of the Grisu2 algorithm from Florian Loitsch which is licensed under the [MIT License](https://opensource.org/licenses/MIT) (see above). Copyright © 2009 [Florian Loitsch](https://florian.loitsch.com/)
|
||||||
- The class contains a copy of [Hedley](https://nemequ.github.io/hedley/) from Evan Nemerson which is licensed as [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/).
|
- The class contains a copy of [Hedley](https://nemequ.github.io/hedley/) from Evan Nemerson which is licensed as [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/).
|
||||||
- The class contains parts of [Google Abseil](https://github.com/abseil/abseil-cpp) which is licensed under the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).
|
- The class contains parts of [Google Abseil](https://github.com/abseil/abseil-cpp) which is licensed under the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).
|
||||||
- The class contains an adapted version of the Eisel-Lemire algorithm and its table of powers of five from [fast_float](https://github.com/fastfloat/fast_float) by Daniel Lemire and contributors, which is available under the [MIT License](https://opensource.org/licenses/MIT) (used here), the Apache 2.0 License, and the Boost Software License. Copyright © 2021 The fast_float authors
|
- The class contains an adapted version of the Eisel-Lemire algorithm, its table of powers of five, and its digit comparison for long numbers from [fast_float](https://github.com/fastfloat/fast_float) by Daniel Lemire and contributors, which is available under the [MIT License](https://opensource.org/licenses/MIT) (used here), the Apache 2.0 License, and the Boost Software License. Copyright © 2021 The fast_float authors
|
||||||
|
|
||||||
<img align="right" src="https://git.fsfe.org/reuse/reuse-ci/raw/branch/master/reuse-horizontal.png" alt="REUSE Software">
|
<img align="right" src="https://git.fsfe.org/reuse/reuse-ci/raw/branch/master/reuse-horizontal.png" alt="REUSE Software">
|
||||||
|
|
||||||
|
|||||||
+4
-8
@@ -596,9 +596,8 @@ foreach(SRC_FILE ${SRC_FILES})
|
|||||||
add_executable(single_${RELATIVE_SRC_FILE} EXCLUDE_FROM_ALL ${PROJECT_BINARY_DIR}/src_single/${RELATIVE_SRC_FILE}.cpp)
|
add_executable(single_${RELATIVE_SRC_FILE} EXCLUDE_FROM_ALL ${PROJECT_BINARY_DIR}/src_single/${RELATIVE_SRC_FILE}.cpp)
|
||||||
target_include_directories(single_${RELATIVE_SRC_FILE} PRIVATE ${PROJECT_SOURCE_DIR}/include)
|
target_include_directories(single_${RELATIVE_SRC_FILE} PRIVATE ${PROJECT_SOURCE_DIR}/include)
|
||||||
target_compile_features(single_${RELATIVE_SRC_FILE} PRIVATE cxx_std_11)
|
target_compile_features(single_${RELATIVE_SRC_FILE} PRIVATE cxx_std_11)
|
||||||
if(RELATIVE_SRC_FILE STREQUAL "json" OR RELATIVE_SRC_FILE STREQUAL "json_literals")
|
if(RELATIVE_SRC_FILE STREQUAL "json")
|
||||||
# see below: report the diagnostics of json.hpp and json_literals.hpp without --error, so they
|
# see below: report json.hpp's diagnostics without --error, so they do not fail the build
|
||||||
# do not fail the build
|
|
||||||
set_property(TARGET single_${RELATIVE_SRC_FILE} PROPERTY CXX_INCLUDE_WHAT_YOU_USE ${IWYU_TOOL} -Xiwyu --max_line_length=300)
|
set_property(TARGET single_${RELATIVE_SRC_FILE} PROPERTY CXX_INCLUDE_WHAT_YOU_USE ${IWYU_TOOL} -Xiwyu --max_line_length=300)
|
||||||
else()
|
else()
|
||||||
set_property(TARGET single_${RELATIVE_SRC_FILE} PROPERTY CXX_INCLUDE_WHAT_YOU_USE "${iwyu_path_and_options}")
|
set_property(TARGET single_${RELATIVE_SRC_FILE} PROPERTY CXX_INCLUDE_WHAT_YOU_USE "${iwyu_path_and_options}")
|
||||||
@@ -612,10 +611,7 @@ foreach(SRC_FILE ${SRC_FILES})
|
|||||||
# reporting its diagnostics (informational, via CXX_INCLUDE_WHAT_YOU_USE above) but exclude it
|
# reporting its diagnostics (informational, via CXX_INCLUDE_WHAT_YOU_USE above) but exclude it
|
||||||
# from the hard gate below so a fresh IWYU/compiler combination does not fail this target on a
|
# from the hard gate below so a fresh IWYU/compiler combination does not fail this target on a
|
||||||
# nondeterministic suggestion for a header that already re-exports everything on purpose.
|
# nondeterministic suggestion for a header that already re-exports everything on purpose.
|
||||||
# json_literals.hpp and json.hpp include each other on purpose (json.hpp includes it at its end
|
if(NOT RELATIVE_SRC_FILE STREQUAL "json")
|
||||||
# unless JSON_NO_AUTOMATIC_UDLS is defined), and IWYU, not following the cycle, suggests replacing
|
|
||||||
# json.hpp with json_fwd.hpp although the literals need the complete basic_json; exclude it, too.
|
|
||||||
if(NOT RELATIVE_SRC_FILE STREQUAL "json" AND NOT RELATIVE_SRC_FILE STREQUAL "json_literals")
|
|
||||||
list(APPEND single_binaries_tus src_single/${RELATIVE_SRC_FILE}.cpp)
|
list(APPEND single_binaries_tus src_single/${RELATIVE_SRC_FILE}.cpp)
|
||||||
endif()
|
endif()
|
||||||
endforeach()
|
endforeach()
|
||||||
@@ -705,7 +701,7 @@ ci_get_cmake(4.0.0 CMAKE_4_0_0_BINARY)
|
|||||||
# the tests require CMake 3.13 or later, so they are excluded for CMake 3.5.0
|
# the tests require CMake 3.13 or later, so they are excluded for CMake 3.5.0
|
||||||
set(JSON_CMAKE_FLAGS_3_5_0 JSON_Diagnostics JSON_Diagnostic_Positions JSON_GlobalUDLs JSON_ImplicitConversions JSON_DisableEnumSerialization
|
set(JSON_CMAKE_FLAGS_3_5_0 JSON_Diagnostics JSON_Diagnostic_Positions JSON_GlobalUDLs JSON_ImplicitConversions JSON_DisableEnumSerialization
|
||||||
JSON_LegacyDiscardedValueComparison JSON_Install JSON_MultipleHeaders JSON_SystemInclude JSON_Valgrind
|
JSON_LegacyDiscardedValueComparison JSON_Install JSON_MultipleHeaders JSON_SystemInclude JSON_Valgrind
|
||||||
JSON_StrictNulHandling JSON_StrictBinaryUTF8)
|
JSON_StrictNulHandling)
|
||||||
set(JSON_CMAKE_FLAGS_3_31_6 JSON_BuildTests ${JSON_CMAKE_FLAGS_3_5_0})
|
set(JSON_CMAKE_FLAGS_3_31_6 JSON_BuildTests ${JSON_CMAKE_FLAGS_3_5_0})
|
||||||
set(JSON_CMAKE_FLAGS_4_0_0 JSON_BuildTests ${JSON_CMAKE_FLAGS_3_5_0})
|
set(JSON_CMAKE_FLAGS_4_0_0 JSON_BuildTests ${JSON_CMAKE_FLAGS_3_5_0})
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,6 @@ INSERT INTO searchIndex(name, type, path) VALUES ('format_as', 'Function', 'api/
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::accept', 'Function', 'api/basic_json/accept/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::accept', 'Function', 'api/basic_json/accept/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::array', 'Function', 'api/basic_json/array/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::array', 'Function', 'api/basic_json/array/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::array_t', 'Type', 'api/basic_json/array_t/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::array_t', 'Type', 'api/basic_json/array_t/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::as_base_class', 'Method', 'api/basic_json/as_base_class/index.html');
|
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::at', 'Method', 'api/basic_json/at/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::at', 'Method', 'api/basic_json/at/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::back', 'Method', 'api/basic_json/back/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::back', 'Method', 'api/basic_json/back/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::basic_json', 'Constructor', 'api/basic_json/basic_json/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('basic_json::basic_json', 'Constructor', 'api/basic_json/basic_json/index.html');
|
||||||
@@ -242,7 +241,6 @@ INSERT INTO searchIndex(name, type, path) VALUES ('JSON_NO_THREAD_LOCAL', 'Macro
|
|||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_PRECISE_STREAM_POSITION', 'Macro', 'api/macros/json_precise_stream_position/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_PRECISE_STREAM_POSITION', 'Macro', 'api/macros/json_precise_stream_position/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_SKIP_LIBRARY_VERSION_CHECK', 'Macro', 'api/macros/json_skip_library_version_check/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_SKIP_LIBRARY_VERSION_CHECK', 'Macro', 'api/macros/json_skip_library_version_check/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_SKIP_UNSUPPORTED_COMPILER_CHECK', 'Macro', 'api/macros/json_skip_unsupported_compiler_check/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_SKIP_UNSUPPORTED_COMPILER_CHECK', 'Macro', 'api/macros/json_skip_unsupported_compiler_check/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_STRICT_BINARY_UTF8', 'Macro', 'api/macros/json_strict_binary_utf8/index.html');
|
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_STRICT_NUL_HANDLING', 'Macro', 'api/macros/json_strict_nul_handling/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_STRICT_NUL_HANDLING', 'Macro', 'api/macros/json_strict_nul_handling/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_THROW_USER', 'Macro', 'api/macros/json_throw_user/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_THROW_USER', 'Macro', 'api/macros/json_throw_user/index.html');
|
||||||
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_TRY_USER', 'Macro', 'api/macros/json_throw_user/index.html');
|
INSERT INTO searchIndex(name, type, path) VALUES ('JSON_TRY_USER', 'Macro', 'api/macros/json_throw_user/index.html');
|
||||||
|
|||||||
@@ -1,53 +0,0 @@
|
|||||||
# <small>nlohmann::basic_json::</small>as_base_class
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
json_base_class_t& as_base_class() noexcept;
|
|
||||||
const json_base_class_t& as_base_class() const noexcept;
|
|
||||||
```
|
|
||||||
|
|
||||||
Returns a reference to this object as its custom base class [`json_base_class_t`](json_base_class_t.md). No copy is
|
|
||||||
made.
|
|
||||||
|
|
||||||
Since `basic_json` derives from `json_base_class_t`, a member of `basic_json` hides any member of the custom base class
|
|
||||||
with the same name. This function makes such hidden members accessible again.
|
|
||||||
|
|
||||||
## Return value
|
|
||||||
|
|
||||||
reference to this object as [`json_base_class_t`](json_base_class_t.md)
|
|
||||||
|
|
||||||
## Exception safety
|
|
||||||
|
|
||||||
No-throw guarantee: this function never throws exceptions.
|
|
||||||
|
|
||||||
## Complexity
|
|
||||||
|
|
||||||
Constant.
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
The function is equivalent to `static_cast<json_base_class_t&>(j)` (or `static_cast<const json_base_class_t&>(j)`).
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
??? example
|
|
||||||
|
|
||||||
The example shows how to use `as_base_class` to access members of the custom base class that are hidden by members
|
|
||||||
of `basic_json`.
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
--8<-- "examples/as_base_class.cpp"
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
|
|
||||||
```json
|
|
||||||
--8<-- "examples/as_base_class.output"
|
|
||||||
```
|
|
||||||
|
|
||||||
## See also
|
|
||||||
|
|
||||||
- [json_base_class_t](json_base_class_t.md) - type of the custom base class
|
|
||||||
|
|
||||||
## Version history
|
|
||||||
|
|
||||||
- Added in version 3.13.0.
|
|
||||||
@@ -238,7 +238,5 @@ Strong exception safety: if an exception occurs, the original value stays intact
|
|||||||
|
|
||||||
1. Added in version 1.0.0.
|
1. Added in version 1.0.0.
|
||||||
2. Added in version 1.0.0.
|
2. Added in version 1.0.0.
|
||||||
3. Added in version 3.11.0. Fixed in version 3.13.0 to consistently accept `std::string_view`-convertible keys, as
|
3. Added in version 3.11.0.
|
||||||
already supported by [`operator[]`](operator[].md), [`value`](value.md), [`find`](find.md), and other lookup
|
|
||||||
functions.
|
|
||||||
4. Added in version 2.0.0.
|
4. Added in version 2.0.0.
|
||||||
|
|||||||
@@ -293,15 +293,6 @@ basic_json(basic_json&& other) noexcept;
|
|||||||
When used without parentheses around an empty initializer list, `basic_json()` is called instead of this
|
When used without parentheses around an empty initializer list, `basic_json()` is called instead of this
|
||||||
function, yielding the JSON `#!json null` value.
|
function, yielding the JSON `#!json null` value.
|
||||||
|
|
||||||
- Overload 4:
|
|
||||||
|
|
||||||
!!! info "Implicit conversion"
|
|
||||||
|
|
||||||
The conversion is implicit unless [`JSON_USE_IMPLICIT_CONVERSIONS`](../macros/json_use_implicit_conversions.md)
|
|
||||||
is defined to `0` and `BasicJsonType::string_t` differs from `string_t`. In that case, the constructor is
|
|
||||||
`explicit`, so a JSON value with a different string type is no longer silently converted, for example when it is
|
|
||||||
passed to a function taking `#!cpp const json&`. Write `#!cpp json(other)` or `#!cpp other.get<json>()` instead.
|
|
||||||
|
|
||||||
- Overload 7:
|
- Overload 7:
|
||||||
|
|
||||||
!!! info "Preconditions"
|
!!! info "Preconditions"
|
||||||
@@ -475,8 +466,7 @@ basic_json(basic_json&& other) noexcept;
|
|||||||
1. Since version 1.0.0.
|
1. Since version 1.0.0.
|
||||||
2. Since version 1.0.0.
|
2. Since version 1.0.0.
|
||||||
3. Since version 2.1.0.
|
3. Since version 2.1.0.
|
||||||
4. Since version 3.2.0. Explicit for different string types if `JSON_USE_IMPLICIT_CONVERSIONS` is `0` since
|
4. Since version 3.2.0.
|
||||||
version 3.13.0.
|
|
||||||
5. Since version 1.0.0.
|
5. Since version 1.0.0.
|
||||||
6. Since version 1.0.0.
|
6. Since version 1.0.0.
|
||||||
7. Since version 1.0.0. Fixed in version 3.13.0 to also check the iterator range for binary values; before, a range
|
7. Since version 1.0.0. Fixed in version 3.13.0 to also check the iterator range for binary values; before, a range
|
||||||
|
|||||||
@@ -131,9 +131,7 @@ Logarithmic in the size of the JSON object.
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Added in version 3.11.0.
|
1. Added in version 3.11.0.
|
||||||
2. Added in version 3.6.0. Extended template `KeyType` to support comparable types in version 3.11.0. Fixed in
|
2. Added in version 3.6.0. Extended template `KeyType` to support comparable types in version 3.11.0.
|
||||||
version 3.13.0 to consistently accept `std::string_view`-convertible keys, as already supported by
|
|
||||||
[`operator[]`](operator[].md), [`at`](at.md), [`value`](value.md), and other lookup functions.
|
|
||||||
3. Added in version 3.7.0.
|
3. Added in version 3.7.0.
|
||||||
4. Deleted overloads for integral key types added in version 3.13.0 to reject such calls at compile time instead of
|
4. Deleted overloads for integral key types added in version 3.13.0 to reject such calls at compile time instead of
|
||||||
causing undefined behavior at runtime.
|
causing undefined behavior at runtime.
|
||||||
|
|||||||
@@ -84,8 +84,6 @@ Logarithmic in the size of the JSON object.
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Added in version 3.11.0.
|
1. Added in version 3.11.0.
|
||||||
2. Added in version 1.0.0. Changed parameter `key` type to `KeyType&&` in version 3.11.0. Fixed in version 3.13.0 to
|
2. Added in version 1.0.0. Changed parameter `key` type to `KeyType&&` in version 3.11.0.
|
||||||
consistently accept `std::string_view`-convertible keys, as already supported by [`operator[]`](operator[].md),
|
|
||||||
[`at`](at.md), [`value`](value.md), and other lookup functions.
|
|
||||||
3. Deleted overload for integral key types added in version 3.13.0 to reject such calls at compile time instead of
|
3. Deleted overload for integral key types added in version 3.13.0 to reject such calls at compile time instead of
|
||||||
causing undefined behavior at runtime.
|
causing undefined behavior at runtime.
|
||||||
|
|||||||
@@ -25,12 +25,10 @@ and `ensure_ascii` parameters.
|
|||||||
result consists of ASCII characters only.
|
result consists of ASCII characters only.
|
||||||
|
|
||||||
`error_handler` (in)
|
`error_handler` (in)
|
||||||
: how to react on decoding errors; there are four possible values (see [`error_handler_t`](error_handler_t.md):
|
: how to react on decoding errors; there are three possible values (see [`error_handler_t`](error_handler_t.md):
|
||||||
`strict` (throws an exception in case a decoding error occurs; default), `replace` (replace invalid UTF-8 sequences
|
`strict` (throws an exception in case a decoding error occurs; default), `replace` (replace invalid UTF-8 sequences
|
||||||
with U+FFFD), `ignore` (ignore invalid UTF-8 sequences during serialization; all valid bytes are copied to the
|
with U+FFFD), and `ignore` (ignore invalid UTF-8 sequences during serialization; all valid bytes are copied to the
|
||||||
output unchanged, and invalid bytes are dropped), and `keep` (write the ill-formed bytes to the output as is,
|
output unchanged, and invalid bytes are dropped)).
|
||||||
without escaping them, even if `ensure_ascii` is `#!cpp true`; the result is then not valid UTF-8, but equals the
|
|
||||||
input bytes exactly, and well-formed characters around the ill-formed bytes are still escaped as usual)).
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
@@ -96,4 +94,3 @@ Binary values are serialized as an object containing two keys:
|
|||||||
- Indentation character `indent_char`, option `ensure_ascii` and exceptions added in version 3.0.0.
|
- Indentation character `indent_char`, option `ensure_ascii` and exceptions added in version 3.0.0.
|
||||||
- Error handlers added in version 3.4.0.
|
- Error handlers added in version 3.4.0.
|
||||||
- Serialization of binary values added in version 3.8.0.
|
- Serialization of binary values added in version 3.8.0.
|
||||||
- Error handler `keep` added in version 3.13.0.
|
|
||||||
|
|||||||
@@ -70,5 +70,3 @@ Logarithmic in the size of the container, O(log(`size()`)).
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Since version 2.0.8.
|
- Since version 2.0.8.
|
||||||
- Fixed in version 3.13.0: for [`ordered_json`](../ordered_json.md), the value could previously only be passed as an
|
|
||||||
rvalue; it can now also be passed as an lvalue or a `#!cpp const` lvalue, matching the behavior of `json`.
|
|
||||||
|
|||||||
@@ -213,7 +213,5 @@ Strong exception safety: if an exception occurs, the original value stays intact
|
|||||||
1. Added in version 1.0.0. Added support for binary types in version 3.8.0.
|
1. Added in version 1.0.0. Added support for binary types in version 3.8.0.
|
||||||
2. Added in version 1.0.0. Added support for binary types in version 3.8.0.
|
2. Added in version 1.0.0. Added support for binary types in version 3.8.0.
|
||||||
3. Added in version 1.0.0.
|
3. Added in version 1.0.0.
|
||||||
4. Added in version 3.11.0. Fixed in version 3.13.0 to consistently accept `std::string_view`-convertible keys, as
|
4. Added in version 3.11.0.
|
||||||
already supported by [`operator[]`](operator[].md), [`at`](at.md), [`value`](value.md), and other lookup
|
|
||||||
functions.
|
|
||||||
5. Added in version 1.0.0.
|
5. Added in version 1.0.0.
|
||||||
|
|||||||
@@ -4,31 +4,15 @@
|
|||||||
enum class error_handler_t {
|
enum class error_handler_t {
|
||||||
strict,
|
strict,
|
||||||
replace,
|
replace,
|
||||||
ignore,
|
ignore
|
||||||
keep
|
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
This enumeration is used to choose how to treat ill-formed UTF-8 in a string value or object key:
|
This enumeration is used in the [`dump`](dump.md) function to choose how to treat decoding errors while serializing a
|
||||||
|
`basic_json` value. Three values are differentiated:
|
||||||
- [`dump`](dump.md) uses it while serializing a `basic_json` value to text.
|
|
||||||
- [`to_cbor`](to_cbor.md), [`to_msgpack`](to_msgpack.md), [`to_ubjson`](to_ubjson.md), [`to_bjdata`](to_bjdata.md),
|
|
||||||
and [`to_bson`](to_bson.md) use it while serializing a `basic_json` value to that binary format. Their default is
|
|
||||||
`keep`, as no binary writer checked before this parameter was added. CBOR, UBJSON, BJData, and BSON require valid
|
|
||||||
UTF-8, so for these four the default is `strict` if [`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md)
|
|
||||||
is enabled; MessagePack's specification explicitly allows a string to contain ill-formed UTF-8, so `to_msgpack`
|
|
||||||
stays at `keep`. `to_bon8` does not take this parameter: BON8 always validates, since UTF-8 lead bytes are
|
|
||||||
structural to that format.
|
|
||||||
- [`from_cbor`](from_cbor.md), [`from_msgpack`](from_msgpack.md), [`from_ubjson`](from_ubjson.md),
|
|
||||||
[`from_bjdata`](from_bjdata.md), and [`from_bson`](from_bson.md) use it while parsing that binary format, to decide
|
|
||||||
whether to check a string value or object key for well-formed UTF-8 at all; by default (`keep`) they do not, as no
|
|
||||||
binary reader did before this parameter was added. `from_bon8` does not take this parameter, for the same reason
|
|
||||||
`to_bon8` does not.
|
|
||||||
|
|
||||||
Four values are differentiated:
|
|
||||||
|
|
||||||
strict
|
strict
|
||||||
: throw a `type_error`/`parse_error` exception in case of invalid UTF-8
|
: throw a `type_error` exception in case of invalid UTF-8
|
||||||
|
|
||||||
replace
|
replace
|
||||||
: replace invalid UTF-8 sequences with U+FFFD (� REPLACEMENT CHARACTER)
|
: replace invalid UTF-8 sequences with U+FFFD (� REPLACEMENT CHARACTER)
|
||||||
@@ -36,12 +20,6 @@ replace
|
|||||||
ignore
|
ignore
|
||||||
: ignore invalid UTF-8 sequences; all valid bytes are copied to the output unchanged, and invalid bytes are dropped
|
: ignore invalid UTF-8 sequences; all valid bytes are copied to the output unchanged, and invalid bytes are dropped
|
||||||
|
|
||||||
keep
|
|
||||||
: keep invalid UTF-8 sequences unchanged; only meaningful for the binary formats mentioned above, since [`dump`]
|
|
||||||
(dump.md) itself must produce text, and `keep` there writes the ill-formed bytes to the output as is, so the
|
|
||||||
result is then not valid UTF-8 (but still equals the input bytes exactly, including around any well-formed
|
|
||||||
characters, which are still escaped as usual)
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
??? example
|
??? example
|
||||||
@@ -67,5 +45,3 @@ keep
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.4.0.
|
- Added in version 3.4.0.
|
||||||
- Added `keep`, and made this enumeration apply to the binary readers and writers in addition to `dump`, in version
|
|
||||||
3.13.0.
|
|
||||||
|
|||||||
@@ -88,8 +88,6 @@ Logarithmic in the size of the JSON object.
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Added in version 3.11.0.
|
1. Added in version 3.11.0.
|
||||||
2. Added in version 1.0.0. Changed to support comparable types in version 3.11.0. Fixed in version 3.13.0 to
|
2. Added in version 1.0.0. Changed to support comparable types in version 3.11.0.
|
||||||
consistently accept `std::string_view`-convertible keys, as already supported by [`operator[]`](operator[].md),
|
|
||||||
[`at`](at.md), [`value`](value.md), and other lookup functions.
|
|
||||||
3. Deleted overloads for integral key types added in version 3.13.0 to reject such calls at compile time instead of
|
3. Deleted overloads for integral key types added in version 3.13.0 to reject such calls at compile time instead of
|
||||||
causing undefined behavior at runtime.
|
causing undefined behavior at runtime.
|
||||||
|
|||||||
@@ -5,14 +5,12 @@
|
|||||||
template<typename InputType>
|
template<typename InputType>
|
||||||
static basic_json from_bjdata(InputType&& i,
|
static basic_json from_bjdata(InputType&& i,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
// (2)
|
// (2)
|
||||||
template<typename IteratorType, typename SentinelType = IteratorType>
|
template<typename IteratorType, typename SentinelType = IteratorType>
|
||||||
static basic_json from_bjdata(IteratorType first, SentinelType last,
|
static basic_json from_bjdata(IteratorType first, SentinelType last,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Deserializes a given input to a JSON value using the BJData (Binary JData) serialization format.
|
Deserializes a given input to a JSON value using the BJData (Binary JData) serialization format.
|
||||||
@@ -60,12 +58,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
`allow_exceptions` (in)
|
`allow_exceptions` (in)
|
||||||
: whether to throw exceptions in case of a parse error (optional, `#!cpp true` by default)
|
: whether to throw exceptions in case of a parse error (optional, `#!cpp true` by default)
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string value or object key that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
BJData does not require a decoder to reject ill-formed UTF-8, so checking is opt-in: the default, `keep`, does not
|
|
||||||
check at all, as every binary reader did before this parameter was added; `strict` checks and throws;
|
|
||||||
`replace`/`ignore` sanitize the string the same way [`dump`](dump.md) would
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
||||||
@@ -81,7 +73,7 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
the end of the file was not reached when `strict` was set to true
|
the end of the file was not reached when `strict` was set to true
|
||||||
- Throws [parse_error.112](../../home/exceptions.md#jsonexceptionparse_error112) if a parse error occurs
|
- Throws [parse_error.112](../../home/exceptions.md#jsonexceptionparse_error112) if a parse error occurs
|
||||||
- Throws [parse_error.113](../../home/exceptions.md#jsonexceptionparse_error113) if a string could not be parsed
|
- Throws [parse_error.113](../../home/exceptions.md#jsonexceptionparse_error113) if a string could not be parsed
|
||||||
successfully, or if a string value or object key is not valid UTF-8 and `error_handler` is `strict`
|
successfully
|
||||||
- Throws [out_of_range.408](../../home/exceptions.md#jsonexceptionout_of_range408) if the size of an optimized container
|
- Throws [out_of_range.408](../../home/exceptions.md#jsonexceptionout_of_range408) if the size of an optimized container
|
||||||
or n-dimensional array cannot be represented by `std::size_t`
|
or n-dimensional array cannot be represented by `std::size_t`
|
||||||
|
|
||||||
@@ -119,4 +111,3 @@ Linear in the size of the input.
|
|||||||
- Added in version 3.11.0.
|
- Added in version 3.11.0.
|
||||||
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
||||||
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0.
|
|
||||||
|
|||||||
@@ -5,14 +5,12 @@
|
|||||||
template<typename InputType>
|
template<typename InputType>
|
||||||
static basic_json from_bson(InputType&& i,
|
static basic_json from_bson(InputType&& i,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
// (2)
|
// (2)
|
||||||
template<typename IteratorType, typename SentinelType = IteratorType>
|
template<typename IteratorType, typename SentinelType = IteratorType>
|
||||||
static basic_json from_bson(IteratorType first, SentinelType last,
|
static basic_json from_bson(IteratorType first, SentinelType last,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Deserializes a given input to a JSON value using the BSON (Binary JSON) serialization format.
|
Deserializes a given input to a JSON value using the BSON (Binary JSON) serialization format.
|
||||||
@@ -60,12 +58,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
`allow_exceptions` (in)
|
`allow_exceptions` (in)
|
||||||
: whether to throw exceptions in case of a parse error (optional, `#!cpp true` by default)
|
: whether to throw exceptions in case of a parse error (optional, `#!cpp true` by default)
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string value or object key that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
BSON does not require a decoder to reject ill-formed UTF-8, so checking is opt-in: the default, `keep`, does not
|
|
||||||
check at all, as every binary reader did before this parameter was added; `strict` checks and throws;
|
|
||||||
`replace`/`ignore` sanitize the string the same way [`dump`](dump.md) would
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
||||||
@@ -83,8 +75,6 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
invalid string or byte array length)
|
invalid string or byte array length)
|
||||||
- Throws [`parse_error.114`](../../home/exceptions.md#jsonexceptionparse_error114) if an unsupported BSON record type is
|
- Throws [`parse_error.114`](../../home/exceptions.md#jsonexceptionparse_error114) if an unsupported BSON record type is
|
||||||
encountered
|
encountered
|
||||||
- Throws [`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) if a string value or object key is
|
|
||||||
not valid UTF-8 and `error_handler` is `strict`
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -121,7 +111,6 @@ Linear in the size of the input.
|
|||||||
- Added in version 3.4.0.
|
- Added in version 3.4.0.
|
||||||
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
||||||
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0.
|
|
||||||
|
|
||||||
!!! warning "Deprecation"
|
!!! warning "Deprecation"
|
||||||
|
|
||||||
|
|||||||
@@ -6,16 +6,14 @@ template<typename InputType>
|
|||||||
static basic_json from_cbor(InputType&& i,
|
static basic_json from_cbor(InputType&& i,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true,
|
||||||
const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error,
|
const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
|
|
||||||
// (2)
|
// (2)
|
||||||
template<typename IteratorType, typename SentinelType = IteratorType>
|
template<typename IteratorType, typename SentinelType = IteratorType>
|
||||||
static basic_json from_cbor(IteratorType first, SentinelType last,
|
static basic_json from_cbor(IteratorType first, SentinelType last,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true,
|
||||||
const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error,
|
const cbor_tag_handler_t tag_handler = cbor_tag_handler_t::error);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Deserializes a given input to a JSON value using the CBOR (Concise Binary Object Representation) serialization format.
|
Deserializes a given input to a JSON value using the CBOR (Concise Binary Object Representation) serialization format.
|
||||||
@@ -67,12 +65,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
: how to treat CBOR tags (optional, `error` by default); see [`cbor_tag_handler_t`](cbor_tag_handler_t.md) for more
|
: how to treat CBOR tags (optional, `error` by default); see [`cbor_tag_handler_t`](cbor_tag_handler_t.md) for more
|
||||||
information
|
information
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string value or object key that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
CBOR does not require a decoder to reject ill-formed UTF-8, so checking is opt-in: the default, `keep`, does not
|
|
||||||
check at all, as every binary reader did before this parameter was added; `strict` checks and throws;
|
|
||||||
`replace`/`ignore` sanitize the string the same way [`dump`](dump.md) would
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
||||||
@@ -88,9 +80,8 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
the end of the file was not reached when `strict` was set to true
|
the end of the file was not reached when `strict` was set to true
|
||||||
- Throws [parse_error.112](../../home/exceptions.md#jsonexceptionparse_error112) if unsupported features from CBOR were
|
- Throws [parse_error.112](../../home/exceptions.md#jsonexceptionparse_error112) if unsupported features from CBOR were
|
||||||
used in the given input or if the input is not valid CBOR
|
used in the given input or if the input is not valid CBOR
|
||||||
- Throws [parse_error.113](../../home/exceptions.md#jsonexceptionparse_error113) if a map key is not a string (keys of
|
- Throws [parse_error.113](../../home/exceptions.md#jsonexceptionparse_error113) if a map key is not a string (keys of other
|
||||||
other types are not supported, as JSON object keys are always strings), or if a string value or object key is not
|
types are not supported, as JSON object keys are always strings) or a string is malformed
|
||||||
valid UTF-8 and `error_handler` is `strict`
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -130,7 +121,6 @@ Linear in the size of the input.
|
|||||||
- Added `tag_handler` parameter in version 3.9.0.
|
- Added `tag_handler` parameter in version 3.9.0.
|
||||||
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
||||||
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0.
|
|
||||||
|
|
||||||
!!! warning "Deprecation"
|
!!! warning "Deprecation"
|
||||||
|
|
||||||
|
|||||||
@@ -5,14 +5,12 @@
|
|||||||
template<typename InputType>
|
template<typename InputType>
|
||||||
static basic_json from_msgpack(InputType&& i,
|
static basic_json from_msgpack(InputType&& i,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
// (2)
|
// (2)
|
||||||
template<typename IteratorType, typename SentinelType = IteratorType>
|
template<typename IteratorType, typename SentinelType = IteratorType>
|
||||||
static basic_json from_msgpack(IteratorType first, SentinelType last,
|
static basic_json from_msgpack(IteratorType first, SentinelType last,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Deserializes a given input to a JSON value using the MessagePack serialization format.
|
Deserializes a given input to a JSON value using the MessagePack serialization format.
|
||||||
@@ -60,12 +58,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
`allow_exceptions` (in)
|
`allow_exceptions` (in)
|
||||||
: whether to throw exceptions in case of a parse error (optional, `#!cpp true` by default)
|
: whether to throw exceptions in case of a parse error (optional, `#!cpp true` by default)
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string value or object key that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
MessagePack's specification explicitly allows ill-formed UTF-8, so checking is opt-in: the default, `keep`, does
|
|
||||||
not check at all, as every binary reader did before this parameter was added; `strict` checks and throws;
|
|
||||||
`replace`/`ignore` sanitize the string the same way [`dump`](dump.md) would
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
||||||
@@ -81,9 +73,8 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
the end of the file was not reached when `strict` was set to true
|
the end of the file was not reached when `strict` was set to true
|
||||||
- Throws [parse_error.112](../../home/exceptions.md#jsonexceptionparse_error112) if unsupported features from
|
- Throws [parse_error.112](../../home/exceptions.md#jsonexceptionparse_error112) if unsupported features from
|
||||||
MessagePack were used in the given input or if the input is not valid MessagePack
|
MessagePack were used in the given input or if the input is not valid MessagePack
|
||||||
- Throws [parse_error.113](../../home/exceptions.md#jsonexceptionparse_error113) if a map key is not a string (keys of
|
- Throws [parse_error.113](../../home/exceptions.md#jsonexceptionparse_error113) if a map key is not a string (keys of other
|
||||||
other types are not supported, as JSON object keys are always strings), or if a string value or object key is not
|
types are not supported, as JSON object keys are always strings) or a string is malformed
|
||||||
valid UTF-8 and `error_handler` is `strict`
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -122,7 +113,6 @@ Linear in the size of the input.
|
|||||||
- Added `allow_exceptions` parameter in version 3.2.0.
|
- Added `allow_exceptions` parameter in version 3.2.0.
|
||||||
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
||||||
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0.
|
|
||||||
|
|
||||||
!!! warning "Deprecation"
|
!!! warning "Deprecation"
|
||||||
|
|
||||||
|
|||||||
@@ -5,14 +5,12 @@
|
|||||||
template<typename InputType>
|
template<typename InputType>
|
||||||
static basic_json from_ubjson(InputType&& i,
|
static basic_json from_ubjson(InputType&& i,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
// (2)
|
// (2)
|
||||||
template<typename IteratorType, typename SentinelType = IteratorType>
|
template<typename IteratorType, typename SentinelType = IteratorType>
|
||||||
static basic_json from_ubjson(IteratorType first, SentinelType last,
|
static basic_json from_ubjson(IteratorType first, SentinelType last,
|
||||||
const bool strict = true,
|
const bool strict = true,
|
||||||
const bool allow_exceptions = true,
|
const bool allow_exceptions = true);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Deserializes a given input to a JSON value using the UBJSON (Universal Binary JSON) serialization format.
|
Deserializes a given input to a JSON value using the UBJSON (Universal Binary JSON) serialization format.
|
||||||
@@ -60,12 +58,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
`allow_exceptions` (in)
|
`allow_exceptions` (in)
|
||||||
: whether to throw exceptions in case of a parse error (optional, `#!cpp true` by default)
|
: whether to throw exceptions in case of a parse error (optional, `#!cpp true` by default)
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string value or object key that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
UBJSON does not require a decoder to reject ill-formed UTF-8, so checking is opt-in: the default, `keep`, does not
|
|
||||||
check at all, as every binary reader did before this parameter was added; `strict` checks and throws;
|
|
||||||
`replace`/`ignore` sanitize the string the same way [`dump`](dump.md) would
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
deserialized JSON value; in case of a parse error and `allow_exceptions` set to `#!cpp false`, the return value will be
|
||||||
@@ -81,7 +73,7 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
the end of the file was not reached when `strict` was set to true
|
the end of the file was not reached when `strict` was set to true
|
||||||
- Throws [parse_error.112](../../home/exceptions.md#jsonexceptionparse_error112) if a parse error occurs
|
- Throws [parse_error.112](../../home/exceptions.md#jsonexceptionparse_error112) if a parse error occurs
|
||||||
- Throws [parse_error.113](../../home/exceptions.md#jsonexceptionparse_error113) if a string could not be parsed
|
- Throws [parse_error.113](../../home/exceptions.md#jsonexceptionparse_error113) if a string could not be parsed
|
||||||
successfully, or if a string value or object key is not valid UTF-8 and `error_handler` is `strict`
|
successfully
|
||||||
- Throws [out_of_range.408](../../home/exceptions.md#jsonexceptionout_of_range408) if the size of an optimized container
|
- Throws [out_of_range.408](../../home/exceptions.md#jsonexceptionout_of_range408) if the size of an optimized container
|
||||||
or n-dimensional array cannot be represented by `std::size_t`
|
or n-dimensional array cannot be represented by `std::size_t`
|
||||||
|
|
||||||
@@ -120,7 +112,6 @@ Linear in the size of the input.
|
|||||||
- Added `allow_exceptions` parameter in version 3.2.0.
|
- Added `allow_exceptions` parameter in version 3.2.0.
|
||||||
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
- Extended container support (1) to include types with lvalue-only ADL `begin`/`end` (matching `std::begin`/`std::end` semantics) in version 3.13.0.
|
||||||
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
- Extended overload (2) to accept heterogeneous iterator+sentinel pairs (C++20 ranges support) in version 3.13.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0.
|
|
||||||
|
|
||||||
!!! warning "Deprecation"
|
!!! warning "Deprecation"
|
||||||
|
|
||||||
|
|||||||
@@ -200,7 +200,6 @@ Direct access to the stored value of a JSON value.
|
|||||||
- [**get_ref**](get_ref.md) - get a reference value
|
- [**get_ref**](get_ref.md) - get a reference value
|
||||||
- [**operator ValueType**](operator_ValueType.md) - get a value
|
- [**operator ValueType**](operator_ValueType.md) - get a value
|
||||||
- [**get_binary**](get_binary.md) - get a binary value
|
- [**get_binary**](get_binary.md) - get a binary value
|
||||||
- [**as_base_class**](as_base_class.md) - access the custom base class
|
|
||||||
|
|
||||||
### Element access
|
### Element access
|
||||||
|
|
||||||
|
|||||||
@@ -27,18 +27,6 @@ A `CustomBaseClass` with non-static data members forfeits `basic_json`'s
|
|||||||
[standard layout](https://en.cppreference.com/w/cpp/named_req/StandardLayoutType) guarantee. See
|
[standard layout](https://en.cppreference.com/w/cpp/named_req/StandardLayoutType) guarantee. See
|
||||||
[Template Parameter Requirements](../../features/types/template_parameters.md#custombaseclass).
|
[Template Parameter Requirements](../../features/types/template_parameters.md#custombaseclass).
|
||||||
|
|
||||||
#### Name conflicts
|
|
||||||
|
|
||||||
Since `basic_json` derives from `CustomBaseClass`, members of `basic_json` hide members of `CustomBaseClass` with the
|
|
||||||
same name. Hidden members remain accessible via [`as_base_class`](as_base_class.md) or by casting the value to
|
|
||||||
`json_base_class_t`.
|
|
||||||
|
|
||||||
!!! warning "Avoid generic member names"
|
|
||||||
|
|
||||||
Future versions of the library may add members to `basic_json` that hide members of `CustomBaseClass` that are
|
|
||||||
accessible today. To reduce the risk of such conflicts, avoid generic names for the members of `CustomBaseClass`,
|
|
||||||
for instance by using a distinctive prefix.
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
??? example
|
??? example
|
||||||
@@ -57,10 +45,8 @@ same name. Hidden members remain accessible via [`as_base_class`](as_base_class.
|
|||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [as_base_class](as_base_class.md) - access the custom base class
|
|
||||||
- [Template Parameter Requirements](../../features/types/template_parameters.md#custombaseclass) - the requirements for `CustomBaseClass`
|
- [Template Parameter Requirements](../../features/types/template_parameters.md#custombaseclass) - the requirements for `CustomBaseClass`
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.12.0.
|
- Added in version 3.12.0.
|
||||||
- Made a public member type in version 3.13.0; it was private before, so it could not be named outside the class.
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ JSON object holding version information
|
|||||||
|
|
||||||
| key | description |
|
| key | description |
|
||||||
|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `compiler` | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `hp`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version). |
|
| `compiler` | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version). On HP aCC compilers, `compiler` is instead the plain string `hp`. |
|
||||||
| `copyright` | The copyright line for the library as string. |
|
| `copyright` | The copyright line for the library as string. |
|
||||||
| `name` | The name of the library as string. |
|
| `name` | The name of the library as string. |
|
||||||
| `platform` | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`. |
|
| `platform` | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`. |
|
||||||
|
|||||||
@@ -23,9 +23,10 @@ type to use.
|
|||||||
## Template parameters
|
## Template parameters
|
||||||
|
|
||||||
`NumberFloatType`
|
`NumberFloatType`
|
||||||
: the type to store floating-point numbers. Parsing and serialization are implemented in terms of
|
: the type to store floating-point numbers. The parser converts `#!cpp float`, `#!cpp double`, and a
|
||||||
`#!cpp std::strtof`/`#!cpp std::strtod`/`#!cpp std::strtold` and `#!cpp std::snprintf`, so the type must be
|
`#!cpp long double` that is IEEE 754 binary64 itself and other `#!cpp long double` formats with
|
||||||
`#!cpp float`, `#!cpp double`, or `#!cpp long double`. The
|
`#!cpp std::from_chars` or `#!cpp std::strtold`, and serialization falls back to `#!cpp std::snprintf`, so the
|
||||||
|
type must be `#!cpp float`, `#!cpp double`, or `#!cpp long double`. The
|
||||||
[binary formats](../../features/binary_formats/index.md) additionally require `#!cpp float` or `#!cpp double`,
|
[binary formats](../../features/binary_formats/index.md) additionally require `#!cpp float` or `#!cpp double`,
|
||||||
because they have no encoding for `#!cpp long double`. See
|
because they have no encoding for `#!cpp long double`. See
|
||||||
[Template Parameter Requirements](../../features/types/template_parameters.md#numberfloattype).
|
[Template Parameter Requirements](../../features/types/template_parameters.md#numberfloattype).
|
||||||
|
|||||||
@@ -89,9 +89,6 @@ Strong exception safety: if an exception occurs, the original value stays intact
|
|||||||
- Throws [`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) if an array index in the passed
|
- Throws [`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) if an array index in the passed
|
||||||
JSON pointer `ptr` exceeds the range of `size_type` (e.g., on 32-bit platforms).
|
JSON pointer `ptr` exceeds the range of `size_type` (e.g., on 32-bit platforms).
|
||||||
|
|
||||||
For the **const** version, an object key or array index in `ptr` that does not exist is not reported by an
|
|
||||||
exception, but is undefined behavior (see the notes below). Use [`at`](at.md) for checked access.
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
1. Constant if `idx` is in the range of the array. Otherwise, linear in `idx - size()`.
|
1. Constant if `idx` is in the range of the array. Otherwise, linear in `idx - size()`.
|
||||||
@@ -106,12 +103,9 @@ Strong exception safety: if an exception occurs, the original value stays intact
|
|||||||
The following cases apply to the **const** overloads; the non-const overloads instead insert the missing element
|
The following cases apply to the **const** overloads; the non-const overloads instead insert the missing element
|
||||||
(see the notes below).
|
(see the notes below).
|
||||||
|
|
||||||
1. If the element at index `idx` does not exist, the behavior is undefined and is **guarded by a
|
1. If the element at index `idx` does not exist, the behavior is undefined.
|
||||||
[runtime assertion](../../features/assertions.md)**!
|
|
||||||
2. If the element with key `key` does not exist, the behavior is undefined and is **guarded by a
|
2. If the element with key `key` does not exist, the behavior is undefined and is **guarded by a
|
||||||
[runtime assertion](../../features/assertions.md)**!
|
[runtime assertion](../../features/assertions.md)**!
|
||||||
3. If the JSON pointer `ptr` refers to an object key or an array index that does not exist, the behavior is
|
|
||||||
undefined and is **guarded by a [runtime assertion](../../features/assertions.md)**!
|
|
||||||
|
|
||||||
1. The non-const version may add values: If `idx` is beyond the range of the array (i.e., `idx >= size()`), then the
|
1. The non-const version may add values: If `idx` is beyond the range of the array (i.e., `idx >= size()`), then the
|
||||||
array is silently filled up with `#!json null` values to make `idx` a valid reference to the last stored element. In
|
array is silently filled up with `#!json null` values to make `idx` a valid reference to the last stored element. In
|
||||||
@@ -279,11 +273,9 @@ Strong exception safety: if an exception occurs, the original value stays intact
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
1. Added in version 1.0.0. Fixed in version 3.13.0 to throw `#!cpp std::length_error` instead of emptying the array and
|
1. Added in version 1.0.0. Fixed in version 3.13.0 to throw `#!cpp std::length_error` instead of emptying the array and
|
||||||
accessing it out of bounds when `idx` equals the maximum value of `size_type`. A missing index in the const version
|
accessing it out of bounds when `idx` equals the maximum value of `size_type`.
|
||||||
is guarded by a runtime assertion since version 3.13.0.
|
|
||||||
2. Added in version 1.0.0. Added overloads for `T* key` in version 1.1.0. Removed overloads for `T* key` (replaced by 3)
|
2. Added in version 1.0.0. Added overloads for `T* key` in version 1.1.0. Removed overloads for `T* key` (replaced by 3)
|
||||||
in version 3.11.0.
|
in version 3.11.0.
|
||||||
3. Added in version 3.11.0. Fixed in version 3.13.0 to consistently accept `std::string_view`-convertible keys, as
|
3. Added in version 3.11.0. Fixed in version 3.13.0 to consistently accept `std::string_view`-convertible keys, as
|
||||||
already supported by [`at`](at.md), [`value`](value.md), [`find`](find.md), and other lookup functions.
|
already supported by [`at`](at.md), [`value`](value.md), [`find`](find.md), and other lookup functions.
|
||||||
4. Added in version 2.0.0. A missing array index in the const version is guarded by a runtime assertion since
|
4. Added in version 2.0.0.
|
||||||
version 3.13.0.
|
|
||||||
|
|||||||
@@ -5,17 +5,17 @@
|
|||||||
bool operator==(const_reference lhs, const_reference rhs) noexcept; // (1)
|
bool operator==(const_reference lhs, const_reference rhs) noexcept; // (1)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator==(const_reference lhs, const ScalarType rhs) noexcept(/* see below */); // (2)
|
bool operator==(const_reference lhs, const ScalarType rhs) noexcept; // (2)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator==(ScalarType lhs, const const_reference rhs) noexcept(/* see below */); // (2)
|
bool operator==(ScalarType lhs, const const_reference rhs) noexcept; // (2)
|
||||||
|
|
||||||
// since C++20
|
// since C++20
|
||||||
class basic_json {
|
class basic_json {
|
||||||
bool operator==(const_reference rhs) const noexcept; // (1)
|
bool operator==(const_reference rhs) const noexcept; // (1)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator==(ScalarType rhs) const noexcept(/* see below */); // (2)
|
bool operator==(ScalarType rhs) const noexcept; // (2)
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -46,12 +46,7 @@ whether the values `lhs`/`*this` and `rhs` are equal
|
|||||||
|
|
||||||
## Exception safety
|
## Exception safety
|
||||||
|
|
||||||
1. No-throw guarantee: this function never throws exceptions.
|
No-throw guarantee: this function never throws exceptions.
|
||||||
2. No-throw guarantee if converting the scalar to a JSON value cannot throw, as for numbers, Booleans, and
|
|
||||||
`#!cpp nullptr`; the function is `#!cpp noexcept` exactly in that case. Otherwise, it throws what the conversion
|
|
||||||
throws, for example `std::bad_alloc` when converting a string, or
|
|
||||||
[`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) for an enum value not mapped by
|
|
||||||
[`NLOHMANN_JSON_SERIALIZE_ENUM_STRICT`](../macros/nlohmann_json_serialize_enum_strict.md).
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -176,4 +171,3 @@ Linear.
|
|||||||
|
|
||||||
1. Added in version 1.0.0. Added C++20 member functions in version 3.11.0.
|
1. Added in version 1.0.0. Added C++20 member functions in version 3.11.0.
|
||||||
2. Added in version 1.0.0. Added C++20 member functions in version 3.11.0.
|
2. Added in version 1.0.0. Added C++20 member functions in version 3.11.0.
|
||||||
Made conditionally `#!cpp noexcept` in version 3.13.0; before, a throwing conversion called `std::terminate`.
|
|
||||||
|
|||||||
@@ -5,10 +5,10 @@
|
|||||||
bool operator>=(const_reference lhs, const_reference rhs) noexcept; // (1)
|
bool operator>=(const_reference lhs, const_reference rhs) noexcept; // (1)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator>=(const_reference lhs, const ScalarType rhs) noexcept(/* see below */); // (2)
|
bool operator>=(const_reference lhs, const ScalarType rhs) noexcept; // (2)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator>=(ScalarType lhs, const const_reference rhs) noexcept(/* see below */); // (2)
|
bool operator>=(ScalarType lhs, const const_reference rhs) noexcept; // (2)
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Compares whether one JSON value `lhs` is greater than or equal to another JSON value `rhs` according to the following
|
1. Compares whether one JSON value `lhs` is greater than or equal to another JSON value `rhs` according to the following
|
||||||
@@ -39,12 +39,7 @@ whether `lhs` is greater than or equal to `rhs`
|
|||||||
|
|
||||||
## Exception safety
|
## Exception safety
|
||||||
|
|
||||||
1. No-throw guarantee: this function never throws exceptions.
|
No-throw guarantee: this function never throws exceptions.
|
||||||
2. No-throw guarantee if converting the scalar to a JSON value cannot throw, as for numbers, Booleans, and
|
|
||||||
`#!cpp nullptr`; the function is `#!cpp noexcept` exactly in that case. Otherwise, it throws what the conversion
|
|
||||||
throws, for example `std::bad_alloc` when converting a string, or
|
|
||||||
[`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) for an enum value not mapped by
|
|
||||||
[`NLOHMANN_JSON_SERIALIZE_ENUM_STRICT`](../macros/nlohmann_json_serialize_enum_strict.md).
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -99,4 +94,3 @@ Linear.
|
|||||||
|
|
||||||
1. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
1. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
||||||
2. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
2. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
||||||
Made conditionally `#!cpp noexcept` in version 3.13.0; before, a throwing conversion called `std::terminate`.
|
|
||||||
|
|||||||
@@ -5,10 +5,10 @@
|
|||||||
bool operator>(const_reference lhs, const_reference rhs) noexcept; // (1)
|
bool operator>(const_reference lhs, const_reference rhs) noexcept; // (1)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator>(const_reference lhs, const ScalarType rhs) noexcept(/* see below */); // (2)
|
bool operator>(const_reference lhs, const ScalarType rhs) noexcept; // (2)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator>(ScalarType lhs, const const_reference rhs) noexcept(/* see below */); // (2)
|
bool operator>(ScalarType lhs, const const_reference rhs) noexcept; // (2)
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Compares whether one JSON value `lhs` is greater than another JSON value `rhs` according to the
|
1. Compares whether one JSON value `lhs` is greater than another JSON value `rhs` according to the
|
||||||
@@ -39,12 +39,7 @@ whether `lhs` is greater than `rhs`
|
|||||||
|
|
||||||
## Exception safety
|
## Exception safety
|
||||||
|
|
||||||
1. No-throw guarantee: this function never throws exceptions.
|
No-throw guarantee: this function never throws exceptions.
|
||||||
2. No-throw guarantee if converting the scalar to a JSON value cannot throw, as for numbers, Booleans, and
|
|
||||||
`#!cpp nullptr`; the function is `#!cpp noexcept` exactly in that case. Otherwise, it throws what the conversion
|
|
||||||
throws, for example `std::bad_alloc` when converting a string, or
|
|
||||||
[`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) for an enum value not mapped by
|
|
||||||
[`NLOHMANN_JSON_SERIALIZE_ENUM_STRICT`](../macros/nlohmann_json_serialize_enum_strict.md).
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -89,4 +84,3 @@ Linear.
|
|||||||
|
|
||||||
1. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
1. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
||||||
2. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
2. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
||||||
Made conditionally `#!cpp noexcept` in version 3.13.0; before, a throwing conversion called `std::terminate`.
|
|
||||||
|
|||||||
@@ -5,10 +5,10 @@
|
|||||||
bool operator<=(const_reference lhs, const_reference rhs) noexcept; // (1)
|
bool operator<=(const_reference lhs, const_reference rhs) noexcept; // (1)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator<=(const_reference lhs, const ScalarType rhs) noexcept(/* see below */); // (2)
|
bool operator<=(const_reference lhs, const ScalarType rhs) noexcept; // (2)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator<=(ScalarType lhs, const const_reference rhs) noexcept(/* see below */); // (2)
|
bool operator<=(ScalarType lhs, const const_reference rhs) noexcept; // (2)
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Compares whether one JSON value `lhs` is less than or equal to another JSON value `rhs`
|
1. Compares whether one JSON value `lhs` is less than or equal to another JSON value `rhs`
|
||||||
@@ -40,12 +40,7 @@ whether `lhs` is less than or equal to `rhs`
|
|||||||
|
|
||||||
## Exception safety
|
## Exception safety
|
||||||
|
|
||||||
1. No-throw guarantee: this function never throws exceptions.
|
No-throw guarantee: this function never throws exceptions.
|
||||||
2. No-throw guarantee if converting the scalar to a JSON value cannot throw, as for numbers, Booleans, and
|
|
||||||
`#!cpp nullptr`; the function is `#!cpp noexcept` exactly in that case. Otherwise, it throws what the conversion
|
|
||||||
throws, for example `std::bad_alloc` when converting a string, or
|
|
||||||
[`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) for an enum value not mapped by
|
|
||||||
[`NLOHMANN_JSON_SERIALIZE_ENUM_STRICT`](../macros/nlohmann_json_serialize_enum_strict.md).
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -100,4 +95,3 @@ Linear.
|
|||||||
|
|
||||||
1. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
1. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
||||||
2. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
2. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
||||||
Made conditionally `#!cpp noexcept` in version 3.13.0; before, a throwing conversion called `std::terminate`.
|
|
||||||
|
|||||||
@@ -5,10 +5,10 @@
|
|||||||
bool operator<(const_reference lhs, const_reference rhs) noexcept; // (1)
|
bool operator<(const_reference lhs, const_reference rhs) noexcept; // (1)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator<(const_reference lhs, const ScalarType rhs) noexcept(/* see below */); // (2)
|
bool operator<(const_reference lhs, const ScalarType rhs) noexcept; // (2)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator<(ScalarType lhs, const const_reference rhs) noexcept(/* see below */); // (2)
|
bool operator<(ScalarType lhs, const const_reference rhs) noexcept; // (2)
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Compares whether one JSON value `lhs` is less than another JSON value `rhs` according to the
|
1. Compares whether one JSON value `lhs` is less than another JSON value `rhs` according to the
|
||||||
@@ -49,12 +49,7 @@ whether `lhs` is less than `rhs`
|
|||||||
|
|
||||||
## Exception safety
|
## Exception safety
|
||||||
|
|
||||||
1. No-throw guarantee: this function never throws exceptions.
|
No-throw guarantee: this function never throws exceptions.
|
||||||
2. No-throw guarantee if converting the scalar to a JSON value cannot throw, as for numbers, Booleans, and
|
|
||||||
`#!cpp nullptr`; the function is `#!cpp noexcept` exactly in that case. Otherwise, it throws what the conversion
|
|
||||||
throws, for example `std::bad_alloc` when converting a string, or
|
|
||||||
[`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) for an enum value not mapped by
|
|
||||||
[`NLOHMANN_JSON_SERIALIZE_ENUM_STRICT`](../macros/nlohmann_json_serialize_enum_strict.md).
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -99,4 +94,3 @@ Linear.
|
|||||||
|
|
||||||
1. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
1. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
||||||
2. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
2. Added in version 1.0.0. Conditionally removed since C++20 in version 3.11.0.
|
||||||
Made conditionally `#!cpp noexcept` in version 3.13.0; before, a throwing conversion called `std::terminate`.
|
|
||||||
|
|||||||
@@ -5,10 +5,10 @@
|
|||||||
bool operator!=(const_reference lhs, const_reference rhs) noexcept; // (1)
|
bool operator!=(const_reference lhs, const_reference rhs) noexcept; // (1)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator!=(const_reference lhs, const ScalarType rhs) noexcept(/* see below */); // (2)
|
bool operator!=(const_reference lhs, const ScalarType rhs) noexcept; // (2)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
bool operator!=(ScalarType lhs, const const_reference rhs) noexcept(/* see below */); // (2)
|
bool operator!=(ScalarType lhs, const const_reference rhs) noexcept; // (2)
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Compares two JSON values for inequality. Returns `#!cpp !(lhs == rhs)`.
|
1. Compares two JSON values for inequality. Returns `#!cpp !(lhs == rhs)`.
|
||||||
@@ -36,12 +36,7 @@ whether the values `lhs`/`*this` and `rhs` are not equal
|
|||||||
|
|
||||||
## Exception safety
|
## Exception safety
|
||||||
|
|
||||||
1. No-throw guarantee: this function never throws exceptions.
|
No-throw guarantee: this function never throws exceptions.
|
||||||
2. No-throw guarantee if converting the scalar to a JSON value cannot throw, as for numbers, Booleans, and
|
|
||||||
`#!cpp nullptr`; the function is `#!cpp noexcept` exactly in that case. Otherwise, it throws what the conversion
|
|
||||||
throws, for example `std::bad_alloc` when converting a string, or
|
|
||||||
[`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) for an enum value not mapped by
|
|
||||||
[`NLOHMANN_JSON_SERIALIZE_ENUM_STRICT`](../macros/nlohmann_json_serialize_enum_strict.md).
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -103,4 +98,3 @@ Linear.
|
|||||||
member function in version 3.13.0; since C++20, the compiler rewrites `a != b` using `operator==`.
|
member function in version 3.13.0; since C++20, the compiler rewrites `a != b` using `operator==`.
|
||||||
2. Added in version 1.0.0. Changed in version 3.13.0 to remove special-casing for `NaN` and `discarded` values;
|
2. Added in version 1.0.0. Changed in version 3.13.0 to remove special-casing for `NaN` and `discarded` values;
|
||||||
`operator!=` now consistently means `!(a == b)`. Since C++20, the compiler rewrites `a != b` using `operator==`.
|
`operator!=` now consistently means `!(a == b)`. Since C++20, the compiler rewrites `a != b` using `operator==`.
|
||||||
Made conditionally `#!cpp noexcept` in version 3.13.0; before, a throwing conversion called `std::terminate`.
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ class basic_json {
|
|||||||
std::partial_ordering operator<=>(const_reference rhs) const noexcept; // (1)
|
std::partial_ordering operator<=>(const_reference rhs) const noexcept; // (1)
|
||||||
|
|
||||||
template<typename ScalarType>
|
template<typename ScalarType>
|
||||||
std::partial_ordering operator<=>(const ScalarType rhs) const noexcept(/* see below */); // (2)
|
std::partial_ordering operator<=>(const ScalarType rhs) const noexcept; // (2)
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -39,12 +39,7 @@ the `std::partial_ordering` of the 3-way comparison of `*this` and `rhs`
|
|||||||
|
|
||||||
## Exception safety
|
## Exception safety
|
||||||
|
|
||||||
1. No-throw guarantee: this function never throws exceptions.
|
No-throw guarantee: this function never throws exceptions.
|
||||||
2. No-throw guarantee if converting the scalar to a JSON value cannot throw, as for numbers, Booleans, and
|
|
||||||
`#!cpp nullptr`; the function is `#!cpp noexcept` exactly in that case. Otherwise, it throws what the conversion
|
|
||||||
throws, for example `std::bad_alloc` when converting a string, or
|
|
||||||
[`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) for an enum value not mapped by
|
|
||||||
[`NLOHMANN_JSON_SERIALIZE_ENUM_STRICT`](../macros/nlohmann_json_serialize_enum_strict.md).
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -103,4 +98,3 @@ Linear.
|
|||||||
|
|
||||||
1. Added in version 3.11.0.
|
1. Added in version 3.11.0.
|
||||||
2. Added in version 3.11.0.
|
2. Added in version 3.11.0.
|
||||||
Made conditionally `#!cpp noexcept` in version 3.13.0; before, a throwing conversion called `std::terminate`.
|
|
||||||
|
|||||||
@@ -5,18 +5,15 @@
|
|||||||
static std::vector<std::uint8_t> to_bjdata(const basic_json& j,
|
static std::vector<std::uint8_t> to_bjdata(const basic_json& j,
|
||||||
const bool use_size = false,
|
const bool use_size = false,
|
||||||
const bool use_type = false,
|
const bool use_type = false,
|
||||||
const bjdata_version_t version = bjdata_version_t::draft2,
|
const bjdata_version_t version = bjdata_version_t::draft2);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
|
|
||||||
// (2)
|
// (2)
|
||||||
static void to_bjdata(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
static void to_bjdata(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
||||||
const bool use_size = false, const bool use_type = false,
|
const bool use_size = false, const bool use_type = false,
|
||||||
const bjdata_version_t version = bjdata_version_t::draft2,
|
const bjdata_version_t version = bjdata_version_t::draft2);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
static void to_bjdata(const basic_json& j, detail::output_adapter<char> o,
|
static void to_bjdata(const basic_json& j, detail::output_adapter<char> o,
|
||||||
const bool use_size = false, const bool use_type = false,
|
const bool use_size = false, const bool use_type = false,
|
||||||
const bjdata_version_t version = bjdata_version_t::draft2,
|
const bjdata_version_t version = bjdata_version_t::draft2);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Serializes a given JSON value `j` to a byte vector using the BJData (Binary JData) serialization format. BJData aims to
|
Serializes a given JSON value `j` to a byte vector using the BJData (Binary JData) serialization format. BJData aims to
|
||||||
@@ -46,12 +43,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
: which version of BJData to use (see note on "Binary values" on [BJData](../../features/binary_formats/bjdata.md));
|
: which version of BJData to use (see note on "Binary values" on [BJData](../../features/binary_formats/bjdata.md));
|
||||||
optional, `#!cpp bjdata_version_t::draft2` by default.
|
optional, `#!cpp bjdata_version_t::draft2` by default.
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string or object key in `j` that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
The default, `keep`, writes the ill-formed bytes to the output as is, as every version of `to_bjdata` did before
|
|
||||||
this parameter was added; `strict` throws; `replace`/`ignore` sanitize it the same way [`dump`](dump.md) would.
|
|
||||||
If [`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled, the default is `strict` instead.
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
1. BJData serialization as byte vector
|
1. BJData serialization as byte vector
|
||||||
@@ -65,9 +56,6 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
|
|
||||||
- Throws [`other_error.502`](../../home/exceptions.md#jsonexceptionother_error502) if `use_type` is true and `use_size`
|
- Throws [`other_error.502`](../../home/exceptions.md#jsonexceptionother_error502) if `use_type` is true and `use_size`
|
||||||
is false, and `j` contains a non-empty array, object, or binary value.
|
is false, and `j` contains a non-empty array, object, or binary value.
|
||||||
- Throws [type_error.316](../../home/exceptions.md#jsonexceptiontype_error316) if a string or object key in `j` is
|
|
||||||
not valid UTF-8 and `error_handler` is `strict` (the default only if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled)
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -116,7 +104,4 @@ Linear in the size of the JSON value `j`.
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.11.0.
|
- Added in version 3.11.0.
|
||||||
- BJData version parameter (for draft3 binary encoding) added in version 3.12.0.
|
- BJData version parameter (for draft3 binary encoding) added in version 3.12.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0. Its default, `keep`, writes the bytes of a string or object key
|
|
||||||
that is not valid UTF-8 unchanged, as before; `strict` (the default if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled) throws `type_error.316`.
|
|
||||||
@@ -2,14 +2,11 @@
|
|||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
// (1)
|
// (1)
|
||||||
static std::vector<std::uint8_t> to_bson(const basic_json& j,
|
static std::vector<std::uint8_t> to_bson(const basic_json& j);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
|
|
||||||
// (2)
|
// (2)
|
||||||
static void to_bson(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
static void to_bson(const basic_json& j, detail::output_adapter<std::uint8_t> o);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
static void to_bson(const basic_json& j, detail::output_adapter<char> o);
|
||||||
static void to_bson(const basic_json& j, detail::output_adapter<char> o,
|
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
BSON (Binary JSON) is a binary format in which zero or more ordered key/value pairs are stored as a single entity (a
|
BSON (Binary JSON) is a binary format in which zero or more ordered key/value pairs are stored as a single entity (a
|
||||||
@@ -28,12 +25,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
`o` (in)
|
`o` (in)
|
||||||
: output adapter to write serialization to
|
: output adapter to write serialization to
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string or object key in `j` that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
The default, `keep`, writes the ill-formed bytes to the output as is, as every version of `to_bson` did before
|
|
||||||
this parameter was added; `strict` throws; `replace`/`ignore` sanitize it the same way [`dump`](dump.md) would.
|
|
||||||
If [`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled, the default is `strict` instead.
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
1. BSON serialization as a byte vector
|
1. BSON serialization as a byte vector
|
||||||
@@ -55,9 +46,6 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
- Throws [`out_of_range.415`](../../home/exceptions.md#jsonexceptionout_of_range415) if the subtype of a binary value
|
- Throws [`out_of_range.415`](../../home/exceptions.md#jsonexceptionout_of_range415) if the subtype of a binary value
|
||||||
exceeds 255, the maximum of the BSON binary subtype; example:
|
exceeds 255, the maximum of the BSON binary subtype; example:
|
||||||
`"subtype 70000 is too large for the BSON binary subtype (max 255)"`
|
`"subtype 70000 is too large for the BSON binary subtype (max 255)"`
|
||||||
- Throws [type_error.316](../../home/exceptions.md#jsonexceptiontype_error316) if a string or object key is
|
|
||||||
not valid UTF-8 and `error_handler` is `strict` (the default only if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled)
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -110,7 +98,3 @@ pass before anything is written.
|
|||||||
- Throws `out_of_range.412` and `out_of_range.415` since version 3.13.0.
|
- Throws `out_of_range.412` and `out_of_range.415` since version 3.13.0.
|
||||||
- Linear in the size of `j`, and no longer limited by the call stack for deeply nested values, since version 3.13.0.
|
- Linear in the size of `j`, and no longer limited by the call stack for deeply nested values, since version 3.13.0.
|
||||||
- `out_of_range.415` is now detected before anything is written, like the other exceptions above, since version 3.13.0.
|
- `out_of_range.415` is now detected before anything is written, like the other exceptions above, since version 3.13.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0. Its default, `keep`, writes the bytes of a string or object key
|
|
||||||
that is not valid UTF-8 unchanged, as before; `strict` (the default if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled) throws `type_error.316` before anything
|
|
||||||
is written.
|
|
||||||
|
|||||||
@@ -2,14 +2,11 @@
|
|||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
// (1)
|
// (1)
|
||||||
static std::vector<std::uint8_t> to_cbor(const basic_json& j,
|
static std::vector<std::uint8_t> to_cbor(const basic_json& j);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
|
|
||||||
// (2)
|
// (2)
|
||||||
static void to_cbor(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
static void to_cbor(const basic_json& j, detail::output_adapter<std::uint8_t> o);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
static void to_cbor(const basic_json& j, detail::output_adapter<char> o);
|
||||||
static void to_cbor(const basic_json& j, detail::output_adapter<char> o,
|
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Serializes a given JSON value `j` to a byte vector using the CBOR (Concise Binary Object Representation) serialization
|
Serializes a given JSON value `j` to a byte vector using the CBOR (Concise Binary Object Representation) serialization
|
||||||
@@ -29,12 +26,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
`o` (in)
|
`o` (in)
|
||||||
: output adapter to write serialization to
|
: output adapter to write serialization to
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string or object key in `j` that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
The default, `keep`, writes the ill-formed bytes to the output as is, as every version of `to_cbor` did before
|
|
||||||
this parameter was added; `strict` throws; `replace`/`ignore` sanitize it the same way [`dump`](dump.md) would.
|
|
||||||
If [`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled, the default is `strict` instead.
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
1. CBOR serialization as a byte vector
|
1. CBOR serialization as a byte vector
|
||||||
@@ -44,12 +35,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
|
|
||||||
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
|
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
|
||||||
|
|
||||||
## Exceptions
|
|
||||||
|
|
||||||
- Throws [type_error.316](../../home/exceptions.md#jsonexceptiontype_error316) if a string or object key in `j` is
|
|
||||||
not valid UTF-8 and `error_handler` is `strict` (the default only if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled)
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
Linear in the size of the JSON value `j`.
|
Linear in the size of the JSON value `j`.
|
||||||
@@ -83,6 +68,3 @@ Linear in the size of the JSON value `j`.
|
|||||||
|
|
||||||
- Added in version 2.0.9.
|
- Added in version 2.0.9.
|
||||||
- Compact representation of floating-point numbers added in version 3.8.0.
|
- Compact representation of floating-point numbers added in version 3.8.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0. Its default, `keep`, writes the bytes of a string or object key
|
|
||||||
that is not valid UTF-8 unchanged, as before; `strict` (the default if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled) throws `type_error.316`.
|
|
||||||
|
|||||||
@@ -2,14 +2,11 @@
|
|||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
// (1)
|
// (1)
|
||||||
static std::vector<std::uint8_t> to_msgpack(const basic_json& j,
|
static std::vector<std::uint8_t> to_msgpack(const basic_json& j);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
|
|
||||||
// (2)
|
// (2)
|
||||||
static void to_msgpack(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
static void to_msgpack(const basic_json& j, detail::output_adapter<std::uint8_t> o);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
static void to_msgpack(const basic_json& j, detail::output_adapter<char> o);
|
||||||
static void to_msgpack(const basic_json& j, detail::output_adapter<char> o,
|
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Serializes a given JSON value `j` to a byte vector using the MessagePack serialization format. MessagePack is a binary
|
Serializes a given JSON value `j` to a byte vector using the MessagePack serialization format. MessagePack is a binary
|
||||||
@@ -28,13 +25,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
`o` (in)
|
`o` (in)
|
||||||
: output adapter to write serialization to
|
: output adapter to write serialization to
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string or object key in `j` that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
The default, `keep`, writes the ill-formed bytes to the output as is, as every version of `to_msgpack` did before
|
|
||||||
this parameter was added and as the MessagePack specification allows; `strict` throws; `replace`/`ignore` sanitize
|
|
||||||
it the same way [`dump`](dump.md) would. Unlike the other binary writers, the default stays `keep` even if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled.
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
1. MessagePack serialization as a byte vector
|
1. MessagePack serialization as a byte vector
|
||||||
@@ -52,8 +42,6 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
- Throws [`out_of_range.415`](../../home/exceptions.md#jsonexceptionout_of_range415) if the subtype of a binary value
|
- Throws [`out_of_range.415`](../../home/exceptions.md#jsonexceptionout_of_range415) if the subtype of a binary value
|
||||||
exceeds 255, the maximum of the MessagePack ext type; example:
|
exceeds 255, the maximum of the MessagePack ext type; example:
|
||||||
`"subtype 70000 is too large for the MessagePack ext type (max 255)"`
|
`"subtype 70000 is too large for the MessagePack ext type (max 255)"`
|
||||||
- Throws [type_error.316](../../home/exceptions.md#jsonexceptiontype_error316) if a string or object key in `j` is
|
|
||||||
not valid UTF-8 and `error_handler` is `strict`
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -103,8 +91,6 @@ Linear in the size of the JSON value `j`.
|
|||||||
|
|
||||||
- Added in version 2.0.9.
|
- Added in version 2.0.9.
|
||||||
- Throws `out_of_range.412` and `out_of_range.415` since version 3.13.0.
|
- Throws `out_of_range.412` and `out_of_range.415` since version 3.13.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0. Its default, `keep`, writes the bytes of a string or object key
|
|
||||||
that is not valid UTF-8 unchanged, as before.
|
|
||||||
- Fixed in version 3.13.0 to serialize `number_integer_t`/`number_unsigned_t` pairs of different width correctly;
|
- Fixed in version 3.13.0 to serialize `number_integer_t`/`number_unsigned_t` pairs of different width correctly;
|
||||||
before, integers could be serialized with the wrong value if `number_integer_t` was narrower than
|
before, integers could be serialized with the wrong value if `number_integer_t` was narrower than
|
||||||
`number_unsigned_t`.
|
`number_unsigned_t`.
|
||||||
|
|||||||
@@ -4,16 +4,13 @@
|
|||||||
// (1)
|
// (1)
|
||||||
static std::vector<std::uint8_t> to_ubjson(const basic_json& j,
|
static std::vector<std::uint8_t> to_ubjson(const basic_json& j,
|
||||||
const bool use_size = false,
|
const bool use_size = false,
|
||||||
const bool use_type = false,
|
const bool use_type = false);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
|
|
||||||
// (2)
|
// (2)
|
||||||
static void to_ubjson(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
static void to_ubjson(const basic_json& j, detail::output_adapter<std::uint8_t> o,
|
||||||
const bool use_size = false, const bool use_type = false,
|
const bool use_size = false, const bool use_type = false);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
static void to_ubjson(const basic_json& j, detail::output_adapter<char> o,
|
static void to_ubjson(const basic_json& j, detail::output_adapter<char> o,
|
||||||
const bool use_size = false, const bool use_type = false,
|
const bool use_size = false, const bool use_type = false);
|
||||||
const error_handler_t error_handler = error_handler_t::keep);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Serializes a given JSON value `j` to a byte vector using the UBJSON (Universal Binary JSON) serialization format. UBJSON
|
Serializes a given JSON value `j` to a byte vector using the UBJSON (Universal Binary JSON) serialization format. UBJSON
|
||||||
@@ -39,12 +36,6 @@ The exact mapping and its limitations are described on a [dedicated page](../../
|
|||||||
: whether to add type annotations to container types (must be combined with `#!cpp use_size = true`); optional,
|
: whether to add type annotations to container types (must be combined with `#!cpp use_size = true`); optional,
|
||||||
`#!cpp false` by default.
|
`#!cpp false` by default.
|
||||||
|
|
||||||
`error_handler` (in)
|
|
||||||
: how to treat a string or object key in `j` that is not valid UTF-8; see [`error_handler_t`](error_handler_t.md).
|
|
||||||
The default, `keep`, writes the ill-formed bytes to the output as is, as every version of `to_ubjson` did before
|
|
||||||
this parameter was added; `strict` throws; `replace`/`ignore` sanitize it the same way [`dump`](dump.md) would.
|
|
||||||
If [`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled, the default is `strict` instead.
|
|
||||||
|
|
||||||
## Return value
|
## Return value
|
||||||
|
|
||||||
1. UBJSON serialization as a byte vector
|
1. UBJSON serialization as a byte vector
|
||||||
@@ -58,9 +49,6 @@ Strong guarantee: if an exception is thrown, there are no changes in the JSON va
|
|||||||
|
|
||||||
- Throws [`other_error.502`](../../home/exceptions.md#jsonexceptionother_error502) if `use_type` is true and `use_size`
|
- Throws [`other_error.502`](../../home/exceptions.md#jsonexceptionother_error502) if `use_type` is true and `use_size`
|
||||||
is false, and `j` contains a non-empty array, object, or binary value.
|
is false, and `j` contains a non-empty array, object, or binary value.
|
||||||
- Throws [type_error.316](../../home/exceptions.md#jsonexceptiontype_error316) if a string or object key in `j` is
|
|
||||||
not valid UTF-8 and `error_handler` is `strict` (the default only if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled)
|
|
||||||
|
|
||||||
## Complexity
|
## Complexity
|
||||||
|
|
||||||
@@ -109,6 +97,3 @@ Linear in the size of the JSON value `j`.
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.1.0.
|
- Added in version 3.1.0.
|
||||||
- Added `error_handler` parameter in version 3.13.0. Its default, `keep`, writes the bytes of a string or object key
|
|
||||||
that is not valid UTF-8 unchanged, as before; `strict` (the default if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../macros/json_strict_binary_utf8.md) is enabled) throws `type_error.316`.
|
|
||||||
|
|||||||
@@ -222,9 +222,7 @@ changes to any JSON value.
|
|||||||
1. Added in version 1.0.0. Changed parameter `default_value` type from `const ValueType&` to `ValueType&&` in version
|
1. Added in version 1.0.0. Changed parameter `default_value` type from `const ValueType&` to `ValueType&&` in version
|
||||||
3.11.0. Deleted overload for integral key types added in version 3.13.0 to reject such calls at compile time
|
3.11.0. Deleted overload for integral key types added in version 3.13.0 to reject such calls at compile time
|
||||||
instead of causing undefined behavior at runtime.
|
instead of causing undefined behavior at runtime.
|
||||||
2. Added in version 3.11.0. Made `ValueType` the first template parameter in version 3.11.2. Fixed in version 3.13.0
|
2. Added in version 3.11.0. Made `ValueType` the first template parameter in version 3.11.2.
|
||||||
to consistently accept `std::string_view`-convertible keys, as already supported by
|
|
||||||
[`operator[]`](operator[].md), [`at`](at.md), [`find`](find.md), and other lookup functions.
|
|
||||||
3. Added in version 2.0.2. Extended to work with arrays in version 3.13.0, including fixing an issue where resolving
|
3. Added in version 2.0.2. Extended to work with arrays in version 3.13.0, including fixing an issue where resolving
|
||||||
`ptr` through an array unexpectedly threw `out_of_range` instead of returning the resolved element (or
|
`ptr` through an array unexpectedly threw `out_of_range` instead of returning the resolved element (or
|
||||||
`default_value`, as documented).
|
`default_value`, as documented).
|
||||||
|
|||||||
@@ -18,8 +18,6 @@ header. See also the [macro overview page](../../features/macros.md).
|
|||||||
|
|
||||||
- [**JSON_PRECISE_STREAM_POSITION**](json_precise_stream_position.md) - opt in to leaving an input stream positioned
|
- [**JSON_PRECISE_STREAM_POSITION**](json_precise_stream_position.md) - opt in to leaving an input stream positioned
|
||||||
right after a parsed number
|
right after a parsed number
|
||||||
- [**JSON_STRICT_BINARY_UTF8**](json_strict_binary_utf8.md) - opt in to checking strings for valid UTF-8 in the CBOR,
|
|
||||||
UBJSON, BJData, and BSON writers
|
|
||||||
- [**JSON_STRICT_NUL_HANDLING**](json_strict_nul_handling.md) - opt in to rejecting a NUL byte in the input instead of
|
- [**JSON_STRICT_NUL_HANDLING**](json_strict_nul_handling.md) - opt in to rejecting a NUL byte in the input instead of
|
||||||
treating it as end of input
|
treating it as end of input
|
||||||
|
|
||||||
|
|||||||
@@ -115,4 +115,3 @@ The default value is `0` (disabled — existing behavior is preserved).
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.13.0.
|
- Added in version 3.13.0.
|
||||||
- Planned to become the default (with the macro removed) in version 4.0.0.
|
|
||||||
|
|||||||
@@ -43,9 +43,9 @@ By default, `#!cpp JSON_NO_AUTOMATIC_UDLS` is not defined, and `<nlohmann/json.h
|
|||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
// compiled with -DJSON_NO_AUTOMATIC_UDLS for the whole project
|
// compiled with -DJSON_NO_AUTOMATIC_UDLS for the whole project
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
|
||||||
// this file uses the literals, so it includes them explicitly
|
// this file uses the literals, so it includes them explicitly
|
||||||
// (the header includes <nlohmann/json.hpp> itself)
|
|
||||||
#include <nlohmann/json_literals.hpp>
|
#include <nlohmann/json_literals.hpp>
|
||||||
|
|
||||||
int main()
|
int main()
|
||||||
@@ -62,7 +62,6 @@ By default, `#!cpp JSON_NO_AUTOMATIC_UDLS` is not defined, and `<nlohmann/json.h
|
|||||||
- [`operator""_json`](../operator_literal_json.md)
|
- [`operator""_json`](../operator_literal_json.md)
|
||||||
- [`operator""_json_pointer`](../operator_literal_json_pointer.md)
|
- [`operator""_json_pointer`](../operator_literal_json_pointer.md)
|
||||||
- [`JSON_USE_GLOBAL_UDLS`](json_use_global_udls.md) - place user-defined string literals (UDLs) into the global namespace
|
- [`JSON_USE_GLOBAL_UDLS`](json_use_global_udls.md) - place user-defined string literals (UDLs) into the global namespace
|
||||||
- [Compile times](../../integration/compile_times.md) - options to reduce compile times
|
|
||||||
|
|
||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
|
|||||||
@@ -1,101 +0,0 @@
|
|||||||
# JSON_STRICT_BINARY_UTF8
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
#define JSON_STRICT_BINARY_UTF8 /* value */
|
|
||||||
```
|
|
||||||
|
|
||||||
When defined to `1`, the `error_handler` parameter of the binary writers [`to_cbor`](../basic_json/to_cbor.md),
|
|
||||||
[`to_ubjson`](../basic_json/to_ubjson.md), [`to_bjdata`](../basic_json/to_bjdata.md), and
|
|
||||||
[`to_bson`](../basic_json/to_bson.md) defaults to [`error_handler_t::strict`](../basic_json/error_handler_t.md) instead
|
|
||||||
of `error_handler_t::keep`. These writers then check every string value and object key for valid UTF-8 and throw
|
|
||||||
[`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for ill-formed UTF-8, like
|
|
||||||
[`dump`](../basic_json/dump.md) does. Without it, they write the bytes unchanged. An `error_handler` passed explicitly
|
|
||||||
always takes precedence.
|
|
||||||
|
|
||||||
The macro does not affect:
|
|
||||||
|
|
||||||
- [`to_msgpack`](../basic_json/to_msgpack.md): the MessagePack specification allows a `str` value to contain bytes that
|
|
||||||
are not valid UTF-8, so its `error_handler` always defaults to `keep`.
|
|
||||||
- [`to_bon8`](../basic_json/to_bon8.md): BON8 always checks, because the UTF-8 lead bytes mark where a string ends.
|
|
||||||
- The binary readers ([`from_cbor`](../basic_json/from_cbor.md), [`from_msgpack`](../basic_json/from_msgpack.md),
|
|
||||||
[`from_ubjson`](../basic_json/from_ubjson.md), [`from_bjdata`](../basic_json/from_bjdata.md),
|
|
||||||
[`from_bson`](../basic_json/from_bson.md)): none of these formats requires a decoder to reject ill-formed UTF-8, so
|
|
||||||
they always return the bytes unchanged.
|
|
||||||
|
|
||||||
## Default definition
|
|
||||||
|
|
||||||
The default value is `0` (disabled, the behavior of version 3.12.0 and earlier is preserved).
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
#define JSON_STRICT_BINARY_UTF8 0
|
|
||||||
```
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
!!! note "Background"
|
|
||||||
|
|
||||||
CBOR, UBJSON, BJData, and BSON all require strings to be UTF-8. Up to version 3.12.0, the writers did not check
|
|
||||||
this, so they could produce output that other decoders reject. Checking by default would break code that stores
|
|
||||||
other encodings (for instance ISO 8859-1) in a string and only ever writes it to a binary format. You can pass
|
|
||||||
`error_handler_t::strict` to each call, or use this macro to check by default ahead of version 4.0.0, where
|
|
||||||
`strict` is planned to become the default (see
|
|
||||||
[#5529](https://github.com/nlohmann/json/issues/5529) and [#5651](https://github.com/nlohmann/json/issues/5651)).
|
|
||||||
|
|
||||||
!!! warning "Opt-in only"
|
|
||||||
|
|
||||||
This macro must be defined **before** including `<nlohmann/json.hpp>`. Defining it after the include has no
|
|
||||||
effect.
|
|
||||||
|
|
||||||
!!! note "ABI compatibility"
|
|
||||||
|
|
||||||
The value of this macro is encoded in the [namespace](../../features/namespace.md) (tag `_sbu8`), resulting in
|
|
||||||
distinct symbol names. Translation units compiled with and without it can therefore be linked into the same program
|
|
||||||
without One Definition Rule (ODR) violations, but they cannot exchange instances of library types.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
??? example "Example: default behavior (macro not defined)"
|
|
||||||
|
|
||||||
Without the macro, the bytes are written unchanged:
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
#include <nlohmann/json.hpp>
|
|
||||||
|
|
||||||
using json = nlohmann::json;
|
|
||||||
|
|
||||||
int main()
|
|
||||||
{
|
|
||||||
auto v = json::to_cbor(json("\xFF"));
|
|
||||||
// v is {0x61, 0xFF}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Example: opt-in check (macro defined to 1)"
|
|
||||||
|
|
||||||
With the macro, ill-formed UTF-8 is rejected:
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
#define JSON_STRICT_BINARY_UTF8 1
|
|
||||||
#include <nlohmann/json.hpp>
|
|
||||||
|
|
||||||
using json = nlohmann::json;
|
|
||||||
|
|
||||||
int main()
|
|
||||||
{
|
|
||||||
auto v = json::to_cbor(json("\xFF"));
|
|
||||||
// throws type_error.316: invalid UTF-8 byte at index 0: 0xFF
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## See also
|
|
||||||
|
|
||||||
- [**to_cbor**](../basic_json/to_cbor.md) - create a CBOR serialization of a JSON value
|
|
||||||
- [**to_ubjson**](../basic_json/to_ubjson.md) - create a UBJSON serialization of a JSON value
|
|
||||||
- [**to_bjdata**](../basic_json/to_bjdata.md) - create a BJData serialization of a JSON value
|
|
||||||
- [**to_bson**](../basic_json/to_bson.md) - create a BSON serialization of a JSON value
|
|
||||||
- [**error_handler_t**](../basic_json/error_handler_t.md) - how [`dump`](../basic_json/dump.md) treats ill-formed UTF-8
|
|
||||||
|
|
||||||
## Version history
|
|
||||||
|
|
||||||
- Added in version 3.13.0.
|
|
||||||
- Planned to become the default (with the macro removed) in version 4.0.0.
|
|
||||||
@@ -5,9 +5,7 @@
|
|||||||
```
|
```
|
||||||
|
|
||||||
When defined to `0`, implicit conversions are switched off. By default, implicit conversions are switched on. The
|
When defined to `0`, implicit conversions are switched off. By default, implicit conversions are switched on. The
|
||||||
value directly affects [`operator ValueType`](../basic_json/operator_ValueType.md) and the
|
value directly affects [`operator ValueType`](../basic_json/operator_ValueType.md).
|
||||||
[converting constructor](../basic_json/basic_json.md) from a `basic_json` specialization with a different string
|
|
||||||
type (overload 4).
|
|
||||||
|
|
||||||
## Default definition
|
## Default definition
|
||||||
|
|
||||||
@@ -44,7 +42,7 @@ By default, implicit conversions are enabled.
|
|||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
??? example "Example: implicit conversion"
|
??? example
|
||||||
|
|
||||||
This is an example for an implicit conversion:
|
This is an example for an implicit conversion:
|
||||||
|
|
||||||
@@ -61,25 +59,6 @@ By default, implicit conversions are enabled.
|
|||||||
auto s = j.get<std::string>();
|
auto s = j.get<std::string>();
|
||||||
```
|
```
|
||||||
|
|
||||||
??? example "Example: conversion between `basic_json` specializations"
|
|
||||||
|
|
||||||
A `basic_json` specialization with a different string type is also no longer converted implicitly when
|
|
||||||
`JSON_USE_IMPLICIT_CONVERSIONS` is defined to `0`:
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
using wjson = nlohmann::basic_json<std::map, std::vector, std::wstring>;
|
|
||||||
|
|
||||||
void load(const nlohmann::json& j);
|
|
||||||
|
|
||||||
wjson wj = /* ... */;
|
|
||||||
load(wj); // error: no implicit conversion
|
|
||||||
load(nlohmann::json(wj)); // OK: explicit conversion
|
|
||||||
load(wj.get<nlohmann::json>()); // OK: explicit conversion
|
|
||||||
```
|
|
||||||
|
|
||||||
Specializations that share the same string type, such as `json` and `ordered_json`, remain implicitly
|
|
||||||
convertible.
|
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [**operator ValueType**](../basic_json/operator_ValueType.md) - get a value (implicit)
|
- [**operator ValueType**](../basic_json/operator_ValueType.md) - get a value (implicit)
|
||||||
@@ -89,4 +68,3 @@ By default, implicit conversions are enabled.
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.9.0.
|
- Added in version 3.9.0.
|
||||||
- Also affects the conversion between `basic_json` specializations with different string types since version 3.13.0.
|
|
||||||
|
|||||||
@@ -81,6 +81,3 @@ When the macro is not defined, the library will define it to its default value.
|
|||||||
## Version history
|
## Version history
|
||||||
|
|
||||||
- Added in version 3.11.0.
|
- Added in version 3.11.0.
|
||||||
- Fixed in version 3.13.0 so `<=` and `>=` also emulate the legacy behavior in C++20 when the JSON value is the
|
|
||||||
right-hand operand of a scalar comparison; before, only the 3-way-comparison-rewritten candidate was found, which
|
|
||||||
yielded `#!cpp false` instead of `#!cpp true`.
|
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ work items are tracked in the [GitHub milestones](https://github.com/nlohmann/js
|
|||||||
opt-in.
|
opt-in.
|
||||||
- **Keep the 3.x public API stable.** Releases follow [semantic versioning](https://semver.org). Changes that would
|
- **Keep the 3.x public API stable.** Releases follow [semantic versioning](https://semver.org). Changes that would
|
||||||
break existing code are only added behind a feature macro, so users can opt in and test their code before a next
|
break existing code are only added behind a feature macro, so users can opt in and test their code before a next
|
||||||
major release, see [Version 4.0](#version-40).
|
major release.
|
||||||
- **Support a broad range of compilers and platforms.** The [CI](quality_assurance.md) keeps testing old and new
|
- **Support a broad range of compilers and platforms.** The [CI](quality_assurance.md) keeps testing old and new
|
||||||
versions of GCC, Clang, MSVC, and other compilers on Linux, macOS, and Windows.
|
versions of GCC, Clang, MSVC, and other compilers on Linux, macOS, and Windows.
|
||||||
- **Keep the quality assurance up.** Every change keeps the test coverage at 100%, passes the static and dynamic
|
- **Keep the quality assurance up.** Every change keeps the test coverage at 100%, passes the static and dynamic
|
||||||
@@ -37,67 +37,7 @@ work items are tracked in the [GitHub milestones](https://github.com/nlohmann/js
|
|||||||
|
|
||||||
## Version 4.0
|
## Version 4.0
|
||||||
|
|
||||||
There is no release date for version 4.0 yet. Proposals that need a major version, for instance stricter type
|
There is no decision yet on whether or when a version 4.0 with breaking changes will be released. Proposals that need
|
||||||
conversions, are collected in issue [#3453](https://github.com/nlohmann/json/issues/3453).
|
a major version, for instance stricter type conversions, are collected in issue
|
||||||
|
[#3453](https://github.com/nlohmann/json/issues/3453). Until then, such changes are only added as opt-in behavior
|
||||||
!!! note "Not final"
|
behind feature macros.
|
||||||
|
|
||||||
The plan for version 4.0 described below is not final and may still change: macros may be added to or removed from
|
|
||||||
the list, and planned defaults may be revised. Any such change will be documented on this page.
|
|
||||||
|
|
||||||
### Trying out 4.0 today
|
|
||||||
|
|
||||||
Version 4.0 will not be developed on a separate branch. Instead, every breaking change is first added to a 3.x release
|
|
||||||
behind a macro whose default keeps the 3.x behavior. Version 4.0 then switches the defaults and removes the macros.
|
|
||||||
Version 4.0 is therefore the sum of these macros: you can try it on the 3.x release train today by defining each macro
|
|
||||||
to its 4.0 value and fixing what no longer compiles or behaves differently. Once your code works with all of them, it
|
|
||||||
is ready for version 4.0.
|
|
||||||
|
|
||||||
The following macros guard changes that are planned to become the default in version 4.0:
|
|
||||||
|
|
||||||
| Macro | 3.x default | 4.0 behavior | CMake option | Added |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|--------|
|
|
||||||
| [`JSON_USE_IMPLICIT_CONVERSIONS`](../api/macros/json_use_implicit_conversions.md) | `1` | `0`: no implicit conversions from `basic_json` to other types; use [`get`](../api/basic_json/get.md) instead | [`JSON_ImplicitConversions`](../integration/cmake.md#json_implicitconversions) | 3.9.0 |
|
|
||||||
| [`JSON_USE_GLOBAL_UDLS`](../api/macros/json_use_global_udls.md) | `1` | `0`: the string literals `_json` and `_json_pointer` are only available in namespace `nlohmann::literals` | [`JSON_GlobalUDLs`](../integration/cmake.md#json_globaludls) | 3.11.0 |
|
|
||||||
| [`JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON`](../api/macros/json_use_legacy_discarded_value_comparison.md) | `0` | removed: the deprecated legacy comparison of discarded values can no longer be enabled | [`JSON_LegacyDiscardedValueComparison`](../integration/cmake.md#json_legacydiscardedvaluecomparison) | 3.11.0 |
|
|
||||||
| [`JSON_BRACE_INIT_COPY_SEMANTICS`](../api/macros/json_brace_init_copy_semantics.md) | `0` | `1`: single-element brace initialization such as `#!cpp json j{obj};` copies the element instead of creating an array | – | 3.13.0 |
|
|
||||||
| [`JSON_PRECISE_STREAM_POSITION`](../api/macros/json_precise_stream_position.md) | `0` | `1`: reading from a stream does not consume the character after a number | – | 3.13.0 |
|
|
||||||
| [`JSON_STRICT_NUL_HANDLING`](../api/macros/json_strict_nul_handling.md) | `0` | `1`: a NUL byte in the input is a parse error instead of the end of input | [`JSON_StrictNulHandling`](../integration/cmake.md#json_strictnulhandling) | 3.13.0 |
|
|
||||||
| [`JSON_STRICT_BINARY_UTF8`](../api/macros/json_strict_binary_utf8.md) | `0` | `1`: `to_cbor`, `to_ubjson`, `to_bjdata`, and `to_bson` throw for strings that are not valid UTF-8 by default | [`JSON_StrictBinaryUTF8`](../integration/cmake.md#json_strictbinaryutf8) | 3.13.0 |
|
|
||||||
|
|
||||||
For example, the following makes a 3.x release behave like version 4.0 with respect to these changes:
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
#define JSON_USE_IMPLICIT_CONVERSIONS 0
|
|
||||||
#define JSON_USE_GLOBAL_UDLS 0
|
|
||||||
#define JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON 0
|
|
||||||
#define JSON_BRACE_INIT_COPY_SEMANTICS 1
|
|
||||||
#define JSON_PRECISE_STREAM_POSITION 1
|
|
||||||
#define JSON_STRICT_NUL_HANDLING 1
|
|
||||||
#define JSON_STRICT_BINARY_UTF8 1
|
|
||||||
#include <nlohmann/json.hpp>
|
|
||||||
```
|
|
||||||
|
|
||||||
The macros must be defined before the library header is included; setting them once in the build system is the easiest
|
|
||||||
way to achieve this.
|
|
||||||
|
|
||||||
### Removal of deprecated functions
|
|
||||||
|
|
||||||
Version 4.0 will remove all deprecated functions. Compiling with deprecation warnings enabled shows which of them your
|
|
||||||
code still uses. The [migration guide](../integration/migration_guide.md#replace-deprecated-functions) shows how to
|
|
||||||
replace each of them.
|
|
||||||
|
|
||||||
| Deprecated | Since | Migration |
|
|
||||||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|----------------------------------------------------------------------------------|
|
|
||||||
| `#!cpp operator<<(basic_json&, std::istream&)` | 3.0.0 | [Parsing](../integration/migration_guide.md#parsing) |
|
|
||||||
| `#!cpp operator>>(const basic_json&, std::ostream&)` | 3.0.0 | [Miscellaneous functions](../integration/migration_guide.md#miscellaneous-functions) |
|
|
||||||
| `iterator_wrapper` | 3.1.0 | [Miscellaneous functions](../integration/migration_guide.md#miscellaneous-functions) |
|
|
||||||
| [`parse`](../api/basic_json/parse.md), [`accept`](../api/basic_json/accept.md), and [`sax_parse`](../api/basic_json/sax_parse.md) with an initializer list `{ptr, len}` or `{first, last}` | 3.8.0 | [Parsing](../integration/migration_guide.md#parsing) |
|
|
||||||
| [`from_bson`](../api/basic_json/from_bson.md), [`from_cbor`](../api/basic_json/from_cbor.md), [`from_msgpack`](../api/basic_json/from_msgpack.md), and [`from_ubjson`](../api/basic_json/from_ubjson.md) with `(ptr, len)` or an initializer list | 3.8.0 | [Parsing](../integration/migration_guide.md#parsing) |
|
|
||||||
| [`json_pointer::operator string_t`](../api/json_pointer/operator_string_t.md) | 3.11.0 | [JSON Pointers](../integration/migration_guide.md#json-pointers) |
|
|
||||||
| [`json_pointer`](../api/json_pointer/index.md) with a `basic_json` type as template argument, and the overloads of `value`, `contains`, `operator[]`, and `at` accepting such a pointer | 3.11.0 | [JSON Pointers](../integration/migration_guide.md#json-pointers) |
|
|
||||||
| Comparing a [`json_pointer`](../api/json_pointer/index.md) with a string via [`operator==`](../api/json_pointer/operator_eq.md) or [`operator!=`](../api/json_pointer/operator_ne.md) | 3.11.2 | [JSON Pointers](../integration/migration_guide.md#json-pointers) |
|
|
||||||
|
|
||||||
The deprecated legacy comparison of discarded values is controlled by a macro and therefore listed in the table above.
|
|
||||||
|
|
||||||
New breaking changes will follow the same path: they are added to these tables when they land in a 3.x release.
|
|
||||||
|
|||||||
@@ -1,41 +0,0 @@
|
|||||||
#include <iostream>
|
|
||||||
#include <nlohmann/json.hpp>
|
|
||||||
|
|
||||||
class base_class_with_hidden_members
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
const char* type_name() const noexcept
|
|
||||||
{
|
|
||||||
return "my_type_name";
|
|
||||||
}
|
|
||||||
|
|
||||||
std::size_t size() const noexcept
|
|
||||||
{
|
|
||||||
return 42;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
using json = nlohmann::basic_json <
|
|
||||||
std::map,
|
|
||||||
std::vector,
|
|
||||||
std::string,
|
|
||||||
bool,
|
|
||||||
std::int64_t,
|
|
||||||
std::uint64_t,
|
|
||||||
double,
|
|
||||||
std::allocator,
|
|
||||||
nlohmann::adl_serializer,
|
|
||||||
std::vector<std::uint8_t>,
|
|
||||||
base_class_with_hidden_members
|
|
||||||
>;
|
|
||||||
|
|
||||||
int main()
|
|
||||||
{
|
|
||||||
json j = {1, 2, 3};
|
|
||||||
|
|
||||||
// the members of basic_json hide the members of the base class
|
|
||||||
std::cout << j.type_name() << ' ' << j.size() << '\n';
|
|
||||||
|
|
||||||
// access the hidden members of the base class
|
|
||||||
std::cout << j.as_base_class().type_name() << ' ' << j.as_base_class().size() << '\n';
|
|
||||||
}
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
array 3
|
|
||||||
my_type_name 42
|
|
||||||
@@ -20,6 +20,5 @@ int main()
|
|||||||
<< j_invalid.dump(-1, ' ', false, json::error_handler_t::replace)
|
<< j_invalid.dump(-1, ' ', false, json::error_handler_t::replace)
|
||||||
<< "\nstring with ignored invalid characters: "
|
<< "\nstring with ignored invalid characters: "
|
||||||
<< j_invalid.dump(-1, ' ', false, json::error_handler_t::ignore)
|
<< j_invalid.dump(-1, ' ', false, json::error_handler_t::ignore)
|
||||||
<< "\nstring with the invalid byte kept as is (" << j_invalid.dump(-1, ' ', false, json::error_handler_t::keep).size()
|
<< '\n';
|
||||||
<< " bytes, not valid UTF-8 itself)\n";
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
[json.exception.type_error.316] invalid UTF-8 byte at index 2: 0xA9
|
[json.exception.type_error.316] invalid UTF-8 byte at index 2: 0xA9
|
||||||
string with replaced invalid characters: "ä�ü"
|
string with replaced invalid characters: "ä�ü"
|
||||||
string with ignored invalid characters: "äü"
|
string with ignored invalid characters: "äü"
|
||||||
string with the invalid byte kept as is (7 bytes, not valid UTF-8 itself)
|
|
||||||
|
|||||||
@@ -79,7 +79,6 @@ Some important things:
|
|||||||
* When using `get<your_type>()`, `your_type` **MUST** be [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). (There is a way to bypass this requirement described later.)
|
* When using `get<your_type>()`, `your_type` **MUST** be [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). (There is a way to bypass this requirement described later.)
|
||||||
* In function `from_json`, use function [`at()`](../api/basic_json/at.md) to access the object values rather than `operator[]`. In case a key does not exist, `at` throws an exception that you can handle, whereas `operator[]` exhibits undefined behavior.
|
* In function `from_json`, use function [`at()`](../api/basic_json/at.md) to access the object values rather than `operator[]`. In case a key does not exist, `at` throws an exception that you can handle, whereas `operator[]` exhibits undefined behavior.
|
||||||
* You do not need to add serializers or deserializers for STL types like `std::vector`: the library already implements these.
|
* You do not need to add serializers or deserializers for STL types like `std::vector`: the library already implements these.
|
||||||
* If you control the type, consider defining `to_json`/`from_json` as `friend` functions inside the class ("hidden friends"). Argument-dependent lookup then only finds them for your type, which also avoids a [GCC < 11 compilation error](../home/faq.md#incomplete-detector-type-with-gcc-11).
|
|
||||||
|
|
||||||
??? example "Example: serialize a `person` to JSON with `to_json`"
|
??? example "Example: serialize a `person` to JSON with `to_json`"
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,14 @@ before including the `json.hpp` header.
|
|||||||
|
|
||||||
## Function with runtime assertions
|
## Function with runtime assertions
|
||||||
|
|
||||||
### Unchecked access to a const value
|
### Unchecked object access to a const value
|
||||||
|
|
||||||
Function [`operator[]`](../api/basic_json/operator%5B%5D.md) implements unchecked access for arrays and objects. Whereas
|
Function [`operator[]`](../api/basic_json/operator%5B%5D.md) implements unchecked access for objects. Whereas a missing
|
||||||
a missing element is added in the case of non-const values, accessing a const value with a missing object key or an
|
key is added in the case of non-const objects, accessing a const object with a missing key is undefined behavior (think
|
||||||
invalid array index is undefined behavior (think of a dereferenced null pointer) and yields a runtime assertion. This
|
of a dereferenced null pointer) and yields a runtime assertion.
|
||||||
also applies to a [JSON pointer](json_pointer.md) that refers to a missing key or an invalid index.
|
|
||||||
|
|
||||||
If you are not sure whether an element exists, use checked access with the [`at` function](../api/basic_json/at.md)
|
If you are not sure whether an element in an object exists, use checked access with the
|
||||||
or call the [`contains` function](../api/basic_json/contains.md) before.
|
[`at` function](../api/basic_json/at.md) or call the [`contains` function](../api/basic_json/contains.md) before.
|
||||||
|
|
||||||
See also the documentation on [element access](element_access/index.md).
|
See also the documentation on [element access](element_access/index.md).
|
||||||
|
|
||||||
@@ -47,30 +46,7 @@ See also the documentation on [element access](element_access/index.md).
|
|||||||
Output:
|
Output:
|
||||||
|
|
||||||
```
|
```
|
||||||
Assertion failed: (it != m_data.m_value.object->end()), function operator[], file json.hpp, line 28795.
|
Assertion failed: (m_value.object->find(key) != m_value.object->end()), function operator[], file json.hpp, line 2144.
|
||||||
```
|
|
||||||
|
|
||||||
??? example "Example 2: Invalid array index in a JSON pointer"
|
|
||||||
|
|
||||||
The following code will trigger an assertion at runtime:
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
#include <nlohmann/json.hpp>
|
|
||||||
|
|
||||||
using json = nlohmann::json;
|
|
||||||
using namespace nlohmann::literals;
|
|
||||||
|
|
||||||
int main()
|
|
||||||
{
|
|
||||||
const json j = {{"array", {1, 2, 3}}};
|
|
||||||
auto v = j["/array/5"_json_pointer];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
|
|
||||||
```
|
|
||||||
Assertion failed: (idx < m_data.m_value.array->size()), function operator[], file json.hpp, line 28758.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Constructing from an uninitialized iterator range
|
### Constructing from an uninitialized iterator range
|
||||||
|
|||||||
@@ -63,15 +63,6 @@ The library uses the following mapping from JSON values types to BJData types ac
|
|||||||
|
|
||||||
- strings with more than 18446744073709551615 bytes, i.e., 2<sup>64</sup>-1 bytes (theoretical)
|
- strings with more than 18446744073709551615 bytes, i.e., 2<sup>64</sup>-1 bytes (theoretical)
|
||||||
|
|
||||||
!!! warning "UTF-8 validation of string values and object keys"
|
|
||||||
|
|
||||||
BJData strings must use UTF-8 encoding. By default (the [`error_handler`](../../api/basic_json/to_bjdata.md)
|
|
||||||
parameter left at `keep`), `to_bjdata()` writes the bytes of string values and object keys unchanged, even if they
|
|
||||||
are not valid UTF-8. With `error_handler_t::strict`, it throws
|
|
||||||
[`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for ill-formed UTF-8 instead;
|
|
||||||
`replace`/`ignore` sanitize the string. [`JSON_STRICT_BINARY_UTF8`](../../api/macros/json_strict_binary_utf8.md)
|
|
||||||
makes `strict` the default.
|
|
||||||
|
|
||||||
!!! info "Unused BJData markers"
|
!!! info "Unused BJData markers"
|
||||||
|
|
||||||
The following markers are not used in the conversion:
|
The following markers are not used in the conversion:
|
||||||
@@ -217,19 +208,6 @@ The library maps BJData types to JSON value types as follows:
|
|||||||
|
|
||||||
The mapping is **complete** in the sense that any BJData value can be converted to a JSON value.
|
The mapping is **complete** in the sense that any BJData value can be converted to a JSON value.
|
||||||
|
|
||||||
!!! warning "Ill-formed UTF-8 in string values and object keys"
|
|
||||||
|
|
||||||
BJData strings must use UTF-8 encoding, but checking it on read is opt-in: with the
|
|
||||||
[`error_handler`](../../api/basic_json/from_bjdata.md) parameter left at `keep` (the default), `from_bjdata()`
|
|
||||||
accepts a string value or object key whose bytes are not valid UTF-8 and hands them back unchanged. Passing
|
|
||||||
`error_handler_t::strict` makes `from_bjdata()` check and throw
|
|
||||||
[`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) for ill-formed UTF-8, and
|
|
||||||
`replace`/`ignore` sanitize the string instead of keeping it. However,
|
|
||||||
[`dump()`](../../api/basic_json/dump.md) still requires valid UTF-8 and throws
|
|
||||||
[`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for a value read with the default
|
|
||||||
`keep` handler, unless an error handler is passed that replaces or ignores the ill-formed bytes. `to_bjdata()`'s
|
|
||||||
own `error_handler` parameter defaults to `keep` (see above), so such a value is written back unchanged.
|
|
||||||
|
|
||||||
!!! info "Round trips"
|
!!! info "Round trips"
|
||||||
|
|
||||||
A value returned by [`from_bjdata`](../../api/basic_json/from_bjdata.md) can be serialized with
|
A value returned by [`from_bjdata`](../../api/basic_json/from_bjdata.md) can be serialized with
|
||||||
|
|||||||
@@ -109,21 +109,14 @@ The library maps BSON record types to JSON value types as follows:
|
|||||||
If BSON input must be validated for strict specification compliance, validate it separately before passing it to
|
If BSON input must be validated for strict specification compliance, validate it separately before passing it to
|
||||||
`from_bson()`.
|
`from_bson()`.
|
||||||
|
|
||||||
!!! warning "Ill-formed UTF-8 in string values"
|
!!! warning "UTF-8 validation of string values"
|
||||||
|
|
||||||
The BSON specification requires `string` values (type `0x02`) to be valid UTF-8, but this is not required of a
|
The BSON specification requires `string` values (type `0x02`) to be valid UTF-8. This library validates the
|
||||||
decoder, so checking is opt-in: with the [`error_handler`](../../api/basic_json/from_bson.md) parameter left at
|
bytes of every such string at decode time and rejects ill-formed UTF-8 with a
|
||||||
`keep` (the default), `from_bson()` accepts a `string` value whose bytes are not valid UTF-8 and hands them back
|
[`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) exception (or, with `allow_exceptions`
|
||||||
unchanged. Passing `error_handler_t::strict` makes `from_bson()` check and throw
|
set to `false`, a discarded value), rather than only failing later when the resulting value is dumped. Element
|
||||||
[`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) for ill-formed UTF-8, and
|
(key) names and `binary` values (type `0x05`) are unaffected and are never validated, since they are read
|
||||||
`replace`/`ignore` sanitize the string instead of keeping it. However, [`dump()`](../../api/basic_json/dump.md)
|
byte-by-byte as a C string, or are not required to hold text, respectively.
|
||||||
still requires valid UTF-8 and throws [`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for a
|
|
||||||
value read with the default `keep` handler, unless an error handler is passed that replaces or ignores the
|
|
||||||
ill-formed bytes. `to_bson()`'s own `error_handler` parameter defaults to `keep`, so such a string value or element
|
|
||||||
(key) name is written unchanged; with `strict` (the default if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../../api/macros/json_strict_binary_utf8.md) is enabled), it throws the same exception
|
|
||||||
instead. Element (key) names are never validated on read, since they are read byte-by-byte as a C string. `binary`
|
|
||||||
values (type `0x05`) are unaffected, since they are not required to hold text.
|
|
||||||
|
|
||||||
??? example "Example: deserialize a JSON value from BSON"
|
??? example "Example: deserialize a JSON value from BSON"
|
||||||
|
|
||||||
|
|||||||
@@ -189,21 +189,15 @@ The library maps CBOR types to JSON value types as follows:
|
|||||||
([RFC 8392](https://www.rfc-editor.org/rfc/rfc8392.html)), cannot be read with this library and need a
|
([RFC 8392](https://www.rfc-editor.org/rfc/rfc8392.html)), cannot be read with this library and need a
|
||||||
general-purpose CBOR library instead.
|
general-purpose CBOR library instead.
|
||||||
|
|
||||||
!!! warning "Ill-formed UTF-8 in text strings"
|
!!! warning "UTF-8 validation of text strings"
|
||||||
|
|
||||||
[RFC 8949, Section 3.1](https://www.rfc-editor.org/rfc/rfc8949.html#section-3.1) requires CBOR text strings (major
|
[RFC 8949, Section 3.1](https://www.rfc-editor.org/rfc/rfc8949.html#section-3.1) requires CBOR text strings
|
||||||
type 3) to be valid UTF-8, but leaves it up to the decoder whether to enforce this, so checking is opt-in: with the
|
(major type 3) to be valid UTF-8. This library validates the bytes of every text string (object keys included) at
|
||||||
[`error_handler`](../../api/basic_json/from_cbor.md) parameter left at `keep` (the default), `from_cbor()` accepts a
|
decode time and rejects ill-formed UTF-8 with a
|
||||||
text string (object keys included) whose bytes are not valid UTF-8 and hands them back unchanged. Passing
|
[`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) exception (or, with
|
||||||
`error_handler_t::strict` makes `from_cbor()` check and throw
|
`allow_exceptions` set to `false`, a discarded value), rather than only failing later when the resulting value is
|
||||||
[`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) for ill-formed UTF-8, and
|
dumped. Byte strings (major type 2) are unaffected and are never validated, since they are not required to hold
|
||||||
`replace`/`ignore` sanitize the string instead of keeping it. However, [`dump()`](../../api/basic_json/dump.md)
|
text.
|
||||||
still requires valid UTF-8 and throws [`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for a
|
|
||||||
value read with the default `keep` handler, unless an error handler is passed that replaces or ignores the
|
|
||||||
ill-formed bytes. `to_cbor()`'s own [`error_handler`](../../api/basic_json/to_cbor.md) parameter defaults to `keep`,
|
|
||||||
so such a value is written back unchanged; with `strict` (the default if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../../api/macros/json_strict_binary_utf8.md) is enabled), it throws the same exception
|
|
||||||
instead. Byte strings (major type 2) are unaffected, since they are not required to hold text.
|
|
||||||
|
|
||||||
!!! warning "Tagged items"
|
!!! warning "Tagged items"
|
||||||
|
|
||||||
|
|||||||
@@ -153,23 +153,14 @@ The library maps MessagePack types to JSON value types as follows:
|
|||||||
This applies to the [SAX interface](../parsing/sax_interface.md) as well, as the key is read before it is passed
|
This applies to the [SAX interface](../parsing/sax_interface.md) as well, as the key is read before it is passed
|
||||||
on. Such input needs a general-purpose MessagePack library instead.
|
on. Such input needs a general-purpose MessagePack library instead.
|
||||||
|
|
||||||
!!! warning "Ill-formed UTF-8 in string values"
|
!!! warning "UTF-8 validation of string values"
|
||||||
|
|
||||||
The MessagePack specification explicitly allows a `str` value (`fixstr`, `str 8`, `str 16`, `str 32`) to contain
|
The MessagePack specification requires `str` values (`fixstr`, `str 8`, `str 16`, `str 32`) to be valid UTF-8.
|
||||||
a byte sequence that is not valid UTF-8, and expects a deserializer to hand the original bytes back unchanged.
|
This library validates the bytes of every such string (object keys included) at decode time and rejects
|
||||||
This library follows that by default: with its
|
ill-formed UTF-8 with a [`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) exception (or,
|
||||||
[`error_handler`](../../api/basic_json/from_msgpack.md) parameter left at `keep` (the default),
|
with `allow_exceptions` set to `false`, a discarded value), rather than only failing later when the resulting
|
||||||
`from_msgpack()` reads `str` bytes (object keys included) as-is, without validating them, so such a value
|
value is dumped. `bin`/`ext`/`fixext` values are unaffected and are never validated, since they are not required
|
||||||
round-trips through `from_msgpack(to_msgpack(j))` byte for byte. Passing `error_handler_t::strict` makes
|
to hold text.
|
||||||
`from_msgpack()` check anyway and throw
|
|
||||||
[`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) for ill-formed UTF-8, and
|
|
||||||
`replace`/`ignore` sanitize the string instead of keeping it. `to_msgpack()` also writes `str` bytes as-is by
|
|
||||||
default, since the specification permits it; its [`error_handler`](../../api/basic_json/to_msgpack.md) parameter
|
|
||||||
can be set to `strict` to throw [`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) instead, or
|
|
||||||
to `replace`/`ignore` to sanitize the string, for instance for a decoder that rejects ill-formed UTF-8. However,
|
|
||||||
[`dump()`](../../api/basic_json/dump.md) still requires valid UTF-8 and throws
|
|
||||||
[`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for a value read this way with the
|
|
||||||
default `keep` handler, unless an error handler is passed that replaces or ignores the ill-formed bytes.
|
|
||||||
|
|
||||||
??? example "Example: deserialize a JSON value from MessagePack"
|
??? example "Example: deserialize a JSON value from MessagePack"
|
||||||
|
|
||||||
|
|||||||
@@ -47,15 +47,6 @@ The library uses the following mapping from JSON values types to UBJSON types ac
|
|||||||
|
|
||||||
- strings with more than 9223372036854775807 bytes (theoretical)
|
- strings with more than 9223372036854775807 bytes (theoretical)
|
||||||
|
|
||||||
!!! warning "UTF-8 validation of string values and object keys"
|
|
||||||
|
|
||||||
UBJSON's required string encoding is UTF-8. By default (the [`error_handler`](../../api/basic_json/to_ubjson.md)
|
|
||||||
parameter left at `keep`), `to_ubjson()` writes the bytes of string values and object keys unchanged, even if they
|
|
||||||
are not valid UTF-8. With `error_handler_t::strict`, it throws
|
|
||||||
[`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for ill-formed UTF-8 instead;
|
|
||||||
`replace`/`ignore` sanitize the string. [`JSON_STRICT_BINARY_UTF8`](../../api/macros/json_strict_binary_utf8.md)
|
|
||||||
makes `strict` the default.
|
|
||||||
|
|
||||||
!!! info "Unused UBJSON markers"
|
!!! info "Unused UBJSON markers"
|
||||||
|
|
||||||
The following markers are not used in the conversion:
|
The following markers are not used in the conversion:
|
||||||
@@ -129,19 +120,6 @@ The library maps UBJSON types to JSON value types as follows:
|
|||||||
|
|
||||||
The mapping is **complete** in the sense that any UBJSON value can be converted to a JSON value.
|
The mapping is **complete** in the sense that any UBJSON value can be converted to a JSON value.
|
||||||
|
|
||||||
!!! warning "Ill-formed UTF-8 in string values and object keys"
|
|
||||||
|
|
||||||
UBJSON's required string encoding is UTF-8, but checking it on read is opt-in: with the
|
|
||||||
[`error_handler`](../../api/basic_json/from_ubjson.md) parameter left at `keep` (the default), `from_ubjson()`
|
|
||||||
accepts a string value or object key whose bytes are not valid UTF-8 and hands them back unchanged. Passing
|
|
||||||
`error_handler_t::strict` makes `from_ubjson()` check and throw
|
|
||||||
[`parse_error.113`](../../home/exceptions.md#jsonexceptionparse_error113) for ill-formed UTF-8, and
|
|
||||||
`replace`/`ignore` sanitize the string instead of keeping it. However,
|
|
||||||
[`dump()`](../../api/basic_json/dump.md) still requires valid UTF-8 and throws
|
|
||||||
[`type_error.316`](../../home/exceptions.md#jsonexceptiontype_error316) for a value read with the default
|
|
||||||
`keep` handler, unless an error handler is passed that replaces or ignores the ill-formed bytes. `to_ubjson()`'s
|
|
||||||
own `error_handler` parameter defaults to `keep` (see above), so such a value is written back unchanged.
|
|
||||||
|
|
||||||
??? example "Example: deserialize a JSON value from UBJSON"
|
??? example "Example: deserialize a JSON value from UBJSON"
|
||||||
|
|
||||||
```cpp
|
```cpp
|
||||||
|
|||||||
@@ -138,20 +138,6 @@ using the library with compilers that do not fully support C++11 and may only wo
|
|||||||
|
|
||||||
See [full documentation of `JSON_SKIP_UNSUPPORTED_COMPILER_CHECK`](../api/macros/json_skip_unsupported_compiler_check.md).
|
See [full documentation of `JSON_SKIP_UNSUPPORTED_COMPILER_CHECK`](../api/macros/json_skip_unsupported_compiler_check.md).
|
||||||
|
|
||||||
## `JSON_STRICT_BINARY_UTF8`
|
|
||||||
|
|
||||||
When defined to `1`, [`to_cbor`](../api/basic_json/to_cbor.md), [`to_ubjson`](../api/basic_json/to_ubjson.md),
|
|
||||||
[`to_bjdata`](../api/basic_json/to_bjdata.md), and [`to_bson`](../api/basic_json/to_bson.md) throw
|
|
||||||
[`type_error.316`](../home/exceptions.md#jsonexceptiontype_error316) for a string value or object key that is not
|
|
||||||
valid UTF-8. The default value is `0`, which writes the bytes unchanged as before version 3.13.0; this is planned to
|
|
||||||
become the default in version 4.0.0.
|
|
||||||
|
|
||||||
The check can also be enabled with the CMake option
|
|
||||||
[`JSON_StrictBinaryUTF8`](../integration/cmake.md#json_strictbinaryutf8) (`OFF` by default) which sets
|
|
||||||
`JSON_STRICT_BINARY_UTF8` accordingly.
|
|
||||||
|
|
||||||
See [full documentation of `JSON_STRICT_BINARY_UTF8`](../api/macros/json_strict_binary_utf8.md).
|
|
||||||
|
|
||||||
## `JSON_STRICT_NUL_HANDLING`
|
## `JSON_STRICT_NUL_HANDLING`
|
||||||
|
|
||||||
When defined to `1`, a `'\0'` (NUL) byte anywhere in the input is rejected with `parse_error.101`, like any other
|
When defined to `1`, a `'\0'` (NUL) byte anywhere in the input is rejected with `parse_error.101`, like any other
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ The complete default namespace name is derived as follows:
|
|||||||
`_bics`.
|
`_bics`.
|
||||||
- [`JSON_PRECISE_STREAM_POSITION`](../api/macros/json_precise_stream_position.md) defined non-zero appends `_psp`.
|
- [`JSON_PRECISE_STREAM_POSITION`](../api/macros/json_precise_stream_position.md) defined non-zero appends `_psp`.
|
||||||
- [`JSON_STRICT_NUL_HANDLING`](../api/macros/json_strict_nul_handling.md) defined non-zero appends `_snul`.
|
- [`JSON_STRICT_NUL_HANDLING`](../api/macros/json_strict_nul_handling.md) defined non-zero appends `_snul`.
|
||||||
- [`JSON_STRICT_BINARY_UTF8`](../api/macros/json_strict_binary_utf8.md) defined non-zero appends `_sbu8`.
|
|
||||||
- The inline namespace ends with the suffix `_v` followed by the 3 components of the version number separated by
|
- The inline namespace ends with the suffix `_v` followed by the 3 components of the version number separated by
|
||||||
underscores. To omit the version component, see [Disabling the version component](#disabling-the-version-component)
|
underscores. To omit the version component, see [Disabling the version component](#disabling-the-version-component)
|
||||||
below.
|
below.
|
||||||
|
|||||||
@@ -82,12 +82,13 @@ flowchart TD
|
|||||||
|
|
||||||
- Numbers with a decimal digit or scientific notation are always stored as `#!c double`.
|
- Numbers with a decimal digit or scientific notation are always stored as `#!c double`.
|
||||||
- The number types can be changed, see [Template number types](#template-number-types).
|
- The number types can be changed, see [Template number types](#template-number-types).
|
||||||
- Integers are converted by the library's own digit parser. Floating-point numbers are converted with
|
- The library converts integers and floating-point numbers itself, independent of the locale. Floating-point
|
||||||
[`std::from_chars`](https://en.cppreference.com/w/cpp/utility/from_chars) if the library is compiled with C++17
|
numbers are correctly rounded (to nearest, ties to even). Only a `#!c long double` that is not IEEE 754 binary64
|
||||||
and the standard library supports it, then with an exact fast path for `#!c double` values with few significant
|
(e.g., the 80-bit x87 format) is converted with `#!cpp std::from_chars` where available, or else with
|
||||||
digits, and otherwise with the locale-aware
|
[`std::strtold`](https://en.cppreference.com/w/cpp/string/byte/strtof). For that call, the library temporarily
|
||||||
[`std::strtod`](https://en.cppreference.com/w/cpp/string/byte/strtof) (`std::strtof`/`std::strtold` for the
|
replaces the `.` with the decimal point of the current locale (which may be longer than one byte, e.g., in
|
||||||
other floating-point types). Before version 3.13.0, the conversion was realized by
|
`fa_IR.UTF-8`), so the result does not depend on the locale either. Changing the locale in another thread during
|
||||||
|
parsing is undefined behavior of the C library, though. Before version 3.13.0, the conversion was realized by
|
||||||
[`std::strtoull`](https://en.cppreference.com/w/cpp/string/byte/strtoul),
|
[`std::strtoull`](https://en.cppreference.com/w/cpp/string/byte/strtoul),
|
||||||
[`std::strtoll`](https://en.cppreference.com/w/cpp/string/byte/strtol), and `std::strtod`, respectively.
|
[`std::strtoll`](https://en.cppreference.com/w/cpp/string/byte/strtol), and `std::strtod`, respectively.
|
||||||
|
|
||||||
@@ -100,10 +101,10 @@ flowchart TD
|
|||||||
### Number limits
|
### Number limits
|
||||||
|
|
||||||
- Any 64-bit signed or unsigned integer can be stored without loss of precision.
|
- Any 64-bit signed or unsigned integer can be stored without loss of precision.
|
||||||
- Numbers exceeding the limits of `#!c double` (i.e., numbers that after conversion via
|
- Numbers exceeding the limits of `#!c double` (i.e., numbers whose rounded value is not satisfying
|
||||||
[`std::strtod`](https://en.cppreference.com/w/cpp/string/byte/strtof) are not satisfying
|
|
||||||
[`std::isfinite`](https://en.cppreference.com/w/cpp/numeric/math/isfinite) such as `#!c 1E400`) will throw exception
|
[`std::isfinite`](https://en.cppreference.com/w/cpp/numeric/math/isfinite) such as `#!c 1E400`) will throw exception
|
||||||
[`json.exception.out_of_range.406`](../../home/exceptions.md#jsonexceptionout_of_range406) during parsing.
|
[`json.exception.out_of_range.406`](../../home/exceptions.md#jsonexceptionout_of_range406) during parsing. Numbers too
|
||||||
|
small for `#!c double` (such as `#!c 1E-400`) become zero, with the sign of the number.
|
||||||
- Floating-point numbers are rounded to the next number representable as `double`. For instance
|
- Floating-point numbers are rounded to the next number representable as `double`. For instance
|
||||||
`#!c 3.141592653589793238462643383279` is stored as [`0x400921fb54442d18`](https://float.exposed/0x400921fb54442d18).
|
`#!c 3.141592653589793238462643383279` is stored as [`0x400921fb54442d18`](https://float.exposed/0x400921fb54442d18).
|
||||||
This is the same behavior as the code `#!c double x = 3.141592653589793238462643383279;`.
|
This is the same behavior as the code `#!c double x = 3.141592653589793238462643383279;`.
|
||||||
|
|||||||
@@ -26,9 +26,9 @@ Requirements are split into two groups:
|
|||||||
diagnosed with dedicated error messages, and violating most of them results in a compiler error somewhere inside
|
diagnosed with dedicated error messages, and violating most of them results in a compiler error somewhere inside
|
||||||
the library. Four violations are not caught at compile time at all:
|
the library. Four violations are not caught at compile time at all:
|
||||||
|
|
||||||
- A [`StringType`](#stringtype) whose `data()` is not null-terminated compiles and can silently misparse
|
- A [`StringType`](#stringtype) whose `data()` is not null-terminated compiles and silently misparses numbers
|
||||||
floating-point numbers, because the lexer may hand the buffer to `#!cpp std::strtod`, which reads up to the
|
stored as a `#!cpp long double` that is not IEEE 754 binary64 (e.g., the 80-bit x87 format), because the lexer
|
||||||
terminating null character.
|
hands the buffer to `#!cpp std::strtold`.
|
||||||
- A stateful [`AllocatorType`](#allocatortype) compiles and silently ignores its state: allocation, deallocation,
|
- A stateful [`AllocatorType`](#allocatortype) compiles and silently ignores its state: allocation, deallocation,
|
||||||
and [`get_allocator()`](../../api/basic_json/get_allocator.md) each use a different default-constructed instance.
|
and [`get_allocator()`](../../api/basic_json/get_allocator.md) each use a different default-constructed instance.
|
||||||
- The two [cross-specialization conversions](#cross-specialization-conversions) below. These abort on an assertion
|
- The two [cross-specialization conversions](#cross-specialization-conversions) below. These abort on an assertion
|
||||||
@@ -537,9 +537,10 @@ therefore silently changes parse results rather than raising an error. See
|
|||||||
|
|
||||||
`NumberFloatType` must be one of `#!cpp float`, `#!cpp double`, or `#!cpp long double`:
|
`NumberFloatType` must be one of `#!cpp float`, `#!cpp double`, or `#!cpp long double`:
|
||||||
|
|
||||||
- The [parser](../parsing/index.md) converts number literals with `#!cpp std::from_chars` or, as a fallback, with
|
- The [parser](../parsing/index.md) converts number literals to `#!cpp float`, `#!cpp double`, and a
|
||||||
`#!cpp std::strtof`, `#!cpp std::strtod`, or `#!cpp std::strtold`; the library provides overloads for exactly these
|
`#!cpp long double` that is IEEE 754 binary64 itself; other `#!cpp long double` formats are converted with
|
||||||
three types.
|
`#!cpp std::from_chars` where available, or with `#!cpp std::strtold`. The library provides overloads for exactly
|
||||||
|
these three types.
|
||||||
- [`dump`](../../api/basic_json/dump.md) falls back to `#!cpp std::snprintf` with the `%g` and `%Lg` conversion
|
- [`dump`](../../api/basic_json/dump.md) falls back to `#!cpp std::snprintf` with the `%g` and `%Lg` conversion
|
||||||
specifiers, for which the library likewise provides only `#!cpp double` and `#!cpp long double` overloads
|
specifiers, for which the library likewise provides only `#!cpp double` and `#!cpp long double` overloads
|
||||||
(`#!cpp float` is promoted to `#!cpp double`).
|
(`#!cpp float` is promoted to `#!cpp double`).
|
||||||
|
|||||||
@@ -341,10 +341,7 @@ An unexpected byte was read in a [binary format](../features/binary_formats/inde
|
|||||||
|
|
||||||
A string could not be read from a [binary format](../features/binary_formats/index.md): either a value that is not a
|
A string could not be read from a [binary format](../features/binary_formats/index.md): either a value that is not a
|
||||||
string was read where one was required (for instance as a map key), the string's length specification is invalid, or
|
string was read where one was required (for instance as a map key), the string's length specification is invalid, or
|
||||||
the string's bytes are not valid UTF-8 and the `error_handler` parameter of the corresponding `from_*` function is
|
the string's bytes are not valid UTF-8.
|
||||||
set to `strict`. By default (`error_handler_t::keep`), the bytes of a string are not checked for valid UTF-8 on read;
|
|
||||||
see the ill-formed UTF-8 notes on the individual [binary format](../features/binary_formats/index.md) pages for how
|
|
||||||
such a string is handled depending on `error_handler`.
|
|
||||||
|
|
||||||
CBOR and MessagePack allow map keys of any type, but JSON object keys are always strings. Maps with keys of any other
|
CBOR and MessagePack allow map keys of any type, but JSON object keys are always strings. Maps with keys of any other
|
||||||
type (for instance integers or `null`) are therefore not supported; see the notes on
|
type (for instance integers or `null`) are therefore not supported; see the notes on
|
||||||
@@ -752,12 +749,6 @@ The [`unflatten()`](../api/basic_json/unflatten.md) function only works for an o
|
|||||||
|
|
||||||
The [`dump()`](../api/basic_json/dump.md) function only works with UTF-8 encoded strings; that is, if you assign a `std::string` to a JSON value, make sure it is UTF-8 encoded. See the FAQ entry on [serializing untrusted or invalid UTF-8](faq.md#serializing-untrusted-or-invalid-utf-8) for background and the recommended fix.
|
The [`dump()`](../api/basic_json/dump.md) function only works with UTF-8 encoded strings; that is, if you assign a `std::string` to a JSON value, make sure it is UTF-8 encoded. See the FAQ entry on [serializing untrusted or invalid UTF-8](faq.md#serializing-untrusted-or-invalid-utf-8) for background and the recommended fix.
|
||||||
|
|
||||||
The binary writers [`to_cbor()`](../api/basic_json/to_cbor.md), [`to_ubjson()`](../api/basic_json/to_ubjson.md),
|
|
||||||
[`to_bjdata()`](../api/basic_json/to_bjdata.md), and [`to_bson()`](../api/basic_json/to_bson.md) throw this exception
|
|
||||||
as well for a string value or object key that is not valid UTF-8 if their `error_handler` is `strict` (the default if
|
|
||||||
[`JSON_STRICT_BINARY_UTF8`](../api/macros/json_strict_binary_utf8.md) is enabled). So does
|
|
||||||
[`to_msgpack()`](../api/basic_json/to_msgpack.md) if `error_handler_t::strict` is passed.
|
|
||||||
|
|
||||||
!!! failure "Example message"
|
!!! failure "Example message"
|
||||||
|
|
||||||
Calling `dump()` on a JSON value containing an ISO 8859-1 encoded string:
|
Calling `dump()` on a JSON value containing an ISO 8859-1 encoded string:
|
||||||
|
|||||||
@@ -305,51 +305,6 @@ Only very old NDKs (before r18), which defaulted to GCC and `gnustl`, lacked C++
|
|||||||
`std::to_string`. If you run into this, update to a current NDK.
|
`std::to_string`. If you run into this, update to a current NDK.
|
||||||
|
|
||||||
|
|
||||||
### Incomplete `detector` type with GCC < 11
|
|
||||||
|
|
||||||
!!! question
|
|
||||||
|
|
||||||
Why does GCC 10 or older fail with `invalid use of incomplete type 'struct nlohmann::detail::detector<..., to_json_function, ...>'` for a type that holds an `optional` member?
|
|
||||||
|
|
||||||
This happens with GCC 10 and older in C++11/C++14 mode when all of these hold:
|
|
||||||
|
|
||||||
- a class `Holder` has an `optional<Dummy>` member (e.g., `boost::optional`),
|
|
||||||
- `Dummy` has a constructor taking a `json` value, and
|
|
||||||
- `to_json` for `Holder` is a free function in the namespace of `Dummy`.
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
class Dummy {
|
|
||||||
public:
|
|
||||||
explicit Dummy(const nlohmann::json& j);
|
|
||||||
};
|
|
||||||
|
|
||||||
class Holder {
|
|
||||||
boost::optional<Dummy> d;
|
|
||||||
};
|
|
||||||
|
|
||||||
void to_json(nlohmann::json& j, const Holder& h); // triggers the error
|
|
||||||
```
|
|
||||||
|
|
||||||
To decide whether `Dummy` is copyable, the compiler checks whether a `Dummy` can be converted to `json`. That check
|
|
||||||
looks up `to_json` via argument-dependent lookup, finds the unrelated `to_json` for `Holder`, and eventually asks again
|
|
||||||
whether `Dummy` is copyable. GCC before version 11 turns this cycle into a hard error; GCC 11 and later, Clang, and
|
|
||||||
C++17 mode compile the code. The same error shows up without this library whenever a constrained converting constructor
|
|
||||||
is involved, so the library can't avoid it.
|
|
||||||
|
|
||||||
To work around this, define `to_json` (and `from_json`) as a *hidden friend* inside the class. That way,
|
|
||||||
argument-dependent lookup only finds it for `Holder`:
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
class Holder {
|
|
||||||
boost::optional<Dummy> d;
|
|
||||||
|
|
||||||
friend void to_json(nlohmann::json& j, const Holder& h) { /* ... */ }
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
The [`NLOHMANN_DEFINE_TYPE_INTRUSIVE`](../api/macros/nlohmann_define_type_intrusive.md) macros define hidden friends as
|
|
||||||
well. See [#3669](https://github.com/nlohmann/json/issues/3669) for details.
|
|
||||||
|
|
||||||
### Missing STL function
|
### Missing STL function
|
||||||
|
|
||||||
!!! question "Questions"
|
!!! question "Questions"
|
||||||
|
|||||||
@@ -20,4 +20,4 @@ The class contains a slightly modified version of the Grisu2 algorithm from Flor
|
|||||||
|
|
||||||
The class contains a copy of [Hedley](https://nemequ.github.io/hedley/) from Evan Nemerson which is licensed as [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/).
|
The class contains a copy of [Hedley](https://nemequ.github.io/hedley/) from Evan Nemerson which is licensed as [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/).
|
||||||
|
|
||||||
The class contains an adapted version of the Eisel-Lemire algorithm and its table of powers of five from [fast_float](https://github.com/fastfloat/fast_float) by Daniel Lemire and contributors, which is available under the [MIT License](https://opensource.org/licenses/MIT) (used here), the Apache 2.0 License, and the Boost Software License. Copyright © 2021 The fast_float authors
|
The class contains an adapted version of the Eisel-Lemire algorithm, its table of powers of five, and its digit comparison for long numbers from [fast_float](https://github.com/fastfloat/fast_float) by Daniel Lemire and contributors, which is available under the [MIT License](https://opensource.org/licenses/MIT) (used here), the Apache 2.0 License, and the Boost Software License. Copyright © 2021 The fast_float authors
|
||||||
|
|||||||
@@ -212,11 +212,6 @@ Use the non-amalgamated version of the library. This option is `ON` by default.
|
|||||||
|
|
||||||
Treat the library headers like system headers (i.e., adding `SYSTEM` to the [`target_include_directories`](https://cmake.org/cmake/help/latest/command/target_include_directories.html) call) to check for this library by tools like Clang-Tidy. This option is `OFF` by default.
|
Treat the library headers like system headers (i.e., adding `SYSTEM` to the [`target_include_directories`](https://cmake.org/cmake/help/latest/command/target_include_directories.html) call) to check for this library by tools like Clang-Tidy. This option is `OFF` by default.
|
||||||
|
|
||||||
### `JSON_StrictBinaryUTF8`
|
|
||||||
|
|
||||||
Check string values and object keys for valid UTF-8 in the CBOR, UBJSON, BJData, and BSON writers, by defining the
|
|
||||||
macro [`JSON_STRICT_BINARY_UTF8`](../api/macros/json_strict_binary_utf8.md). This option is `OFF` by default.
|
|
||||||
|
|
||||||
### `JSON_StrictNulHandling`
|
### `JSON_StrictNulHandling`
|
||||||
|
|
||||||
Reject a `'\0'` (NUL) byte in the input instead of treating it as end of input, by defining the macro
|
Reject a `'\0'` (NUL) byte in the input instead of treating it as end of input, by defining the macro
|
||||||
|
|||||||
@@ -1,149 +0,0 @@
|
|||||||
# Compile times
|
|
||||||
|
|
||||||
The library is header-only and makes heavy use of templates, so every translation unit that includes
|
|
||||||
`<nlohmann/json.hpp>` pays for parsing the header and instantiating what it uses. This page lists the options to reduce
|
|
||||||
that cost, ordered by how much they typically save.
|
|
||||||
|
|
||||||
!!! info "Measurements"
|
|
||||||
|
|
||||||
The numbers below are medians of nine runs compiling a single translation unit with `-std=c++17 -c` against the
|
|
||||||
single-header version, with Apple clang and GCC 16 on macOS (Apple silicon). They show the order of magnitude to
|
|
||||||
expect; measure your own code before and after a change.
|
|
||||||
|
|
||||||
## Include `json_fwd.hpp` in headers
|
|
||||||
|
|
||||||
Header files that only need to *name* the `json` type — for function declarations, members held by pointer or
|
|
||||||
reference, or friend declarations — can include `<nlohmann/json_fwd.hpp>` instead of `<nlohmann/json.hpp>`. It only
|
|
||||||
forward-declares `basic_json`, `json`, `ordered_json`, `json_pointer`, and `adl_serializer`. The translation units that
|
|
||||||
actually use the values then include `<nlohmann/json.hpp>`.
|
|
||||||
|
|
||||||
```cpp title="person.hpp"
|
|
||||||
#pragma once
|
|
||||||
#include <nlohmann/json_fwd.hpp>
|
|
||||||
|
|
||||||
struct person;
|
|
||||||
void to_json(nlohmann::json& j, const person& p);
|
|
||||||
void from_json(const nlohmann::json& j, person& p);
|
|
||||||
```
|
|
||||||
|
|
||||||
```cpp title="person.cpp"
|
|
||||||
#include "person.hpp"
|
|
||||||
#include <nlohmann/json.hpp>
|
|
||||||
|
|
||||||
void to_json(nlohmann::json& j, const person& p) { /* ... */ }
|
|
||||||
void from_json(const nlohmann::json& j, person& p) { /* ... */ }
|
|
||||||
```
|
|
||||||
|
|
||||||
| Compiler | `json.hpp` (`-O0`) | `json_fwd.hpp` (`-O0`) | Change |
|
|
||||||
|-------------|-------------------:|-----------------------:|-------:|
|
|
||||||
| Apple clang | 704 ms | 329 ms | −53% |
|
|
||||||
| GCC 16 | 779 ms | 242 ms | −69% |
|
|
||||||
|
|
||||||
This is the most effective option, because it avoids the full header in every translation unit that includes
|
|
||||||
*your* headers.
|
|
||||||
|
|
||||||
## Opt out of the automatic user-defined string literals
|
|
||||||
|
|
||||||
The user-defined string literals [`operator""_json`](../api/operator_literal_json.md) and
|
|
||||||
[`operator""_json_pointer`](../api/operator_literal_json_pointer.md) are ordinary inline functions whose bodies call the
|
|
||||||
parser. As `<nlohmann/json.hpp>` includes them by default, every translation unit instantiates the parser, even if it
|
|
||||||
never parses anything itself.
|
|
||||||
|
|
||||||
Define [`JSON_NO_AUTOMATIC_UDLS`](../api/macros/json_no_automatic_udls.md) for the whole project and include
|
|
||||||
`<nlohmann/json_literals.hpp>` instead of `<nlohmann/json.hpp>` in the files that use the literals (it includes
|
|
||||||
`<nlohmann/json.hpp>` itself):
|
|
||||||
|
|
||||||
```cmake
|
|
||||||
target_compile_definitions(my_target PRIVATE JSON_NO_AUTOMATIC_UDLS)
|
|
||||||
```
|
|
||||||
|
|
||||||
```cpp
|
|
||||||
#include <nlohmann/json_literals.hpp> // only where "..."_json is used; includes <nlohmann/json.hpp>
|
|
||||||
```
|
|
||||||
|
|
||||||
The saving applies to translation units that do not parse JSON, for example ones that define types and their
|
|
||||||
conversions or only pass `json` values around:
|
|
||||||
|
|
||||||
| Compiler | Translation unit | Default (`-O0` / `-O2`) | `JSON_NO_AUTOMATIC_UDLS` (`-O0` / `-O2`) | Change |
|
|
||||||
|-------------|------------------|------------------------:|-----------------------------------------:|------------:|
|
|
||||||
| Apple clang | model | 776 ms / 846 ms | 629 ms / 692 ms | −19% / −18% |
|
|
||||||
| GCC 16 | model | 1022 ms / 1120 ms | 882 ms / 965 ms | −14% / −14% |
|
|
||||||
| Apple clang | parsing | 992 ms / 1815 ms | 1006 ms / 1823 ms | +1% / 0% |
|
|
||||||
| GCC 16 | parsing | 2018 ms / 3420 ms | 1990 ms / 3454 ms | −1% / +1% |
|
|
||||||
|
|
||||||
Translation units that include only the header save up to a third. Translation units that parse anyway instantiate
|
|
||||||
the parser regardless and see no difference.
|
|
||||||
|
|
||||||
## Instantiate `basic_json` once
|
|
||||||
|
|
||||||
Each translation unit instantiates the member functions of `nlohmann::json` it uses. An explicit instantiation
|
|
||||||
declaration tells the compiler that the non-template members are instantiated elsewhere, so it can skip them:
|
|
||||||
|
|
||||||
```cpp title="json_instance.hpp"
|
|
||||||
#pragma once
|
|
||||||
#include <nlohmann/json.hpp>
|
|
||||||
|
|
||||||
extern template class nlohmann::basic_json<>;
|
|
||||||
```
|
|
||||||
|
|
||||||
```cpp title="json_instance.cpp"
|
|
||||||
#include "json_instance.hpp"
|
|
||||||
|
|
||||||
template class nlohmann::basic_json<>;
|
|
||||||
```
|
|
||||||
|
|
||||||
Include `json_instance.hpp` instead of `<nlohmann/json.hpp>` and compile and link `json_instance.cpp` once.
|
|
||||||
|
|
||||||
| Compiler | Translation unit | Default (`-O0` / `-O2`) | `extern template` (`-O0` / `-O2`) | Change |
|
|
||||||
|-------------|---------------------|------------------------:|----------------------------------:|------------:|
|
|
||||||
| Apple clang | parsing | 992 ms / 1815 ms | 953 ms / 1625 ms | −4% / −10% |
|
|
||||||
| GCC 16 | parsing | 2018 ms / 3420 ms | 1522 ms / 2728 ms | −25% / −20% |
|
|
||||||
| Apple clang | `json_instance.cpp` | — | 2166 ms / 4660 ms | — |
|
|
||||||
| GCC 16 | `json_instance.cpp` | — | 5085 ms / 10616 ms | — |
|
|
||||||
|
|
||||||
Notes:
|
|
||||||
|
|
||||||
- The saving grows with the number of translation units that use `json`, while the instantiation translation unit is
|
|
||||||
compiled only once (and is rarely recompiled, as it does not depend on your code).
|
|
||||||
- Member function templates (such as `get<T>()`, `parse(InputType&&)`, or `value(key, default)`) are not covered by
|
|
||||||
the explicit instantiation and are still instantiated where they are used.
|
|
||||||
- The declaration covers exactly `nlohmann::json`. Add the same lines for `nlohmann::ordered_json`
|
|
||||||
(`nlohmann::basic_json<nlohmann::ordered_map>`) or your own `basic_json` specializations if you use them.
|
|
||||||
|
|
||||||
## Use C++20 modules
|
|
||||||
|
|
||||||
With a toolchain that supports named modules, `import nlohmann.json;` compiles the library once into a module and
|
|
||||||
avoids parsing the header in every translation unit. See [Modules](../features/modules.md) for requirements and known
|
|
||||||
issues. Module support is experimental and currently depends heavily on the compiler version.
|
|
||||||
|
|
||||||
## Use precompiled headers
|
|
||||||
|
|
||||||
Build systems can precompile `<nlohmann/json.hpp>` together with other stable headers, for example with CMake's
|
|
||||||
[`target_precompile_headers`](https://cmake.org/cmake/help/latest/command/target_precompile_headers.html):
|
|
||||||
|
|
||||||
```cmake
|
|
||||||
target_precompile_headers(my_target PRIVATE <nlohmann/json.hpp>)
|
|
||||||
```
|
|
||||||
|
|
||||||
This removes the cost of parsing the header, but not of instantiating templates in each translation unit, so it
|
|
||||||
combines well with the options above.
|
|
||||||
|
|
||||||
## Options without effect on compile times
|
|
||||||
|
|
||||||
Some configuration macros change what the library declares, but do not measurably change compile times:
|
|
||||||
|
|
||||||
| Macro | Apple clang, model (`-O0` / `-O2`) | GCC 16, model (`-O0` / `-O2`) |
|
|
||||||
|------------------------------------------------------------------------|-----------------------------------:|------------------------------:|
|
|
||||||
| default | 776 ms / 846 ms | 1022 ms / 1120 ms |
|
|
||||||
| [`JSON_NO_IO`](../api/macros/json_no_io.md) | 764 ms / 836 ms | 1022 ms / 1117 ms |
|
|
||||||
| [`JSON_USE_GLOBAL_UDLS`](../api/macros/json_use_global_udls.md)`=0` | 763 ms / 852 ms | 1019 ms / 1106 ms |
|
|
||||||
|
|
||||||
`JSON_USE_GLOBAL_UDLS` only controls *where* the literals are declared; to avoid their cost, use
|
|
||||||
`JSON_NO_AUTOMATIC_UDLS` instead.
|
|
||||||
|
|
||||||
## See also
|
|
||||||
|
|
||||||
- [`JSON_NO_AUTOMATIC_UDLS`](../api/macros/json_no_automatic_udls.md) - do not include the user-defined string
|
|
||||||
literals automatically
|
|
||||||
- [Modules](../features/modules.md) - C++20 module support
|
|
||||||
- [Header only](index.md) - including the library
|
|
||||||
@@ -45,7 +45,7 @@ Clang).
|
|||||||
|
|
||||||
You can further use file
|
You can further use file
|
||||||
[`single_include/nlohmann/json_fwd.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json_fwd.hpp)
|
[`single_include/nlohmann/json_fwd.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json_fwd.hpp)
|
||||||
for forward declarations (see [Compile times](compile_times.md)), and file
|
for forward declarations, and file
|
||||||
[`single_include/nlohmann/json_literals.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json_literals.hpp)
|
[`single_include/nlohmann/json_literals.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json_literals.hpp)
|
||||||
for the user-defined string literals if you define
|
for the user-defined string literals if you define
|
||||||
[`JSON_NO_AUTOMATIC_UDLS`](../api/macros/json_no_automatic_udls.md).
|
[`JSON_NO_AUTOMATIC_UDLS`](../api/macros/json_no_automatic_udls.md).
|
||||||
|
|||||||
@@ -2,14 +2,11 @@
|
|||||||
|
|
||||||
This page collects some guidelines on how to future-proof your code for future versions of this library. For how to
|
This page collects some guidelines on how to future-proof your code for future versions of this library. For how to
|
||||||
add the library to your project in the first place, see [Integration](index.md), [CMake](cmake.md), or
|
add the library to your project in the first place, see [Integration](index.md), [CMake](cmake.md), or
|
||||||
[Package Managers](package_managers.md). The [roadmap](../community/roadmap.md#version-40) lists what will change in
|
[Package Managers](package_managers.md).
|
||||||
version 4.0, including the macros that let you try its behavior with a 3.x release; this page describes how to adjust
|
|
||||||
your code.
|
|
||||||
|
|
||||||
## Replace deprecated functions
|
## Replace deprecated functions
|
||||||
|
|
||||||
The following functions have been deprecated and will be removed in the next major version (i.e., 4.0.0), see the
|
The following functions have been deprecated and will be removed in the next major version (i.e., 4.0.0). All
|
||||||
[roadmap](../community/roadmap.md#removal-of-deprecated-functions) for an overview. All
|
|
||||||
deprecations are annotated with
|
deprecations are annotated with
|
||||||
[`HEDLEY_DEPRECATED_FOR`](https://nemequ.github.io/hedley/api-reference.html#HEDLEY_DEPRECATED_FOR) to report which
|
[`HEDLEY_DEPRECATED_FOR`](https://nemequ.github.io/hedley/api-reference.html#HEDLEY_DEPRECATED_FOR) to report which
|
||||||
function to use instead.
|
function to use instead.
|
||||||
|
|||||||
@@ -108,7 +108,6 @@ nav:
|
|||||||
- integration/cmake.md
|
- integration/cmake.md
|
||||||
- integration/package_managers.md
|
- integration/package_managers.md
|
||||||
- integration/pkg-config.md
|
- integration/pkg-config.md
|
||||||
- integration/compile_times.md
|
|
||||||
- API Documentation:
|
- API Documentation:
|
||||||
- basic_json:
|
- basic_json:
|
||||||
- 'Overview': api/basic_json/index.md
|
- 'Overview': api/basic_json/index.md
|
||||||
@@ -117,7 +116,6 @@ nav:
|
|||||||
- 'accept': api/basic_json/accept.md
|
- 'accept': api/basic_json/accept.md
|
||||||
- 'array': api/basic_json/array.md
|
- 'array': api/basic_json/array.md
|
||||||
- 'array_t': api/basic_json/array_t.md
|
- 'array_t': api/basic_json/array_t.md
|
||||||
- 'as_base_class': api/basic_json/as_base_class.md
|
|
||||||
- 'at': api/basic_json/at.md
|
- 'at': api/basic_json/at.md
|
||||||
- 'back': api/basic_json/back.md
|
- 'back': api/basic_json/back.md
|
||||||
- 'begin': api/basic_json/begin.md
|
- 'begin': api/basic_json/begin.md
|
||||||
@@ -308,7 +306,6 @@ nav:
|
|||||||
- 'JSON_PRECISE_STREAM_POSITION': api/macros/json_precise_stream_position.md
|
- 'JSON_PRECISE_STREAM_POSITION': api/macros/json_precise_stream_position.md
|
||||||
- 'JSON_SKIP_LIBRARY_VERSION_CHECK': api/macros/json_skip_library_version_check.md
|
- 'JSON_SKIP_LIBRARY_VERSION_CHECK': api/macros/json_skip_library_version_check.md
|
||||||
- 'JSON_SKIP_UNSUPPORTED_COMPILER_CHECK': api/macros/json_skip_unsupported_compiler_check.md
|
- 'JSON_SKIP_UNSUPPORTED_COMPILER_CHECK': api/macros/json_skip_unsupported_compiler_check.md
|
||||||
- 'JSON_STRICT_BINARY_UTF8': api/macros/json_strict_binary_utf8.md
|
|
||||||
- 'JSON_STRICT_NUL_HANDLING': api/macros/json_strict_nul_handling.md
|
- 'JSON_STRICT_NUL_HANDLING': api/macros/json_strict_nul_handling.md
|
||||||
- 'JSON_USE_GLOBAL_UDLS': api/macros/json_use_global_udls.md
|
- 'JSON_USE_GLOBAL_UDLS': api/macros/json_use_global_udls.md
|
||||||
- 'JSON_USE_IMPLICIT_CONVERSIONS': api/macros/json_use_implicit_conversions.md
|
- 'JSON_USE_IMPLICIT_CONVERSIONS': api/macros/json_use_implicit_conversions.md
|
||||||
|
|||||||
@@ -46,10 +46,6 @@
|
|||||||
#define JSON_STRICT_NUL_HANDLING 0
|
#define JSON_STRICT_NUL_HANDLING 0
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifndef JSON_STRICT_BINARY_UTF8
|
|
||||||
#define JSON_STRICT_BINARY_UTF8 0
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if JSON_DIAGNOSTICS
|
#if JSON_DIAGNOSTICS
|
||||||
#define NLOHMANN_JSON_ABI_TAG_DIAGNOSTICS _diag
|
#define NLOHMANN_JSON_ABI_TAG_DIAGNOSTICS _diag
|
||||||
#else
|
#else
|
||||||
@@ -86,20 +82,14 @@
|
|||||||
#define NLOHMANN_JSON_ABI_TAG_STRICT_NUL_HANDLING
|
#define NLOHMANN_JSON_ABI_TAG_STRICT_NUL_HANDLING
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if JSON_STRICT_BINARY_UTF8
|
|
||||||
#define NLOHMANN_JSON_ABI_TAG_STRICT_BINARY_UTF8 _sbu8
|
|
||||||
#else
|
|
||||||
#define NLOHMANN_JSON_ABI_TAG_STRICT_BINARY_UTF8
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef NLOHMANN_JSON_NAMESPACE_NO_VERSION
|
#ifndef NLOHMANN_JSON_NAMESPACE_NO_VERSION
|
||||||
#define NLOHMANN_JSON_NAMESPACE_NO_VERSION 0
|
#define NLOHMANN_JSON_NAMESPACE_NO_VERSION 0
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// Construct the namespace ABI tags component
|
// Construct the namespace ABI tags component
|
||||||
#define NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b, c, d, e, f, g) json_abi ## a ## b ## c ## d ## e ## f ## g
|
#define NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b, c, d, e, f) json_abi ## a ## b ## c ## d ## e ## f
|
||||||
#define NLOHMANN_JSON_ABI_TAGS_CONCAT(a, b, c, d, e, f, g) \
|
#define NLOHMANN_JSON_ABI_TAGS_CONCAT(a, b, c, d, e, f) \
|
||||||
NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b, c, d, e, f, g)
|
NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b, c, d, e, f)
|
||||||
|
|
||||||
#define NLOHMANN_JSON_ABI_TAGS \
|
#define NLOHMANN_JSON_ABI_TAGS \
|
||||||
NLOHMANN_JSON_ABI_TAGS_CONCAT( \
|
NLOHMANN_JSON_ABI_TAGS_CONCAT( \
|
||||||
@@ -108,8 +98,7 @@
|
|||||||
NLOHMANN_JSON_ABI_TAG_DIAGNOSTIC_POSITIONS, \
|
NLOHMANN_JSON_ABI_TAG_DIAGNOSTIC_POSITIONS, \
|
||||||
NLOHMANN_JSON_ABI_TAG_BRACE_INIT_COPY_SEMANTICS, \
|
NLOHMANN_JSON_ABI_TAG_BRACE_INIT_COPY_SEMANTICS, \
|
||||||
NLOHMANN_JSON_ABI_TAG_PRECISE_STREAM_POSITION, \
|
NLOHMANN_JSON_ABI_TAG_PRECISE_STREAM_POSITION, \
|
||||||
NLOHMANN_JSON_ABI_TAG_STRICT_NUL_HANDLING, \
|
NLOHMANN_JSON_ABI_TAG_STRICT_NUL_HANDLING)
|
||||||
NLOHMANN_JSON_ABI_TAG_STRICT_BINARY_UTF8)
|
|
||||||
|
|
||||||
// Construct the namespace version component
|
// Construct the namespace version component
|
||||||
#define NLOHMANN_JSON_NAMESPACE_VERSION_CONCAT_EX(major, minor, patch) \
|
#define NLOHMANN_JSON_NAMESPACE_VERSION_CONCAT_EX(major, minor, patch) \
|
||||||
|
|||||||
@@ -39,6 +39,25 @@ inline int count_leading_zeros(std::uint64_t x) noexcept
|
|||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// number of trailing zero bits of x (x != 0)
|
||||||
|
inline int count_trailing_zeros(std::uint64_t x) noexcept
|
||||||
|
{
|
||||||
|
#if defined(__GNUC__) || defined(__clang__)
|
||||||
|
return __builtin_ctzll(x);
|
||||||
|
#else
|
||||||
|
int n = 0;
|
||||||
|
for (int shift = 32; shift != 0; shift >>= 1)
|
||||||
|
{
|
||||||
|
if ((x << (64 - shift)) == 0)
|
||||||
|
{
|
||||||
|
n += shift;
|
||||||
|
x >>= shift;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return n;
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
/// the 128-bit product of two 64-bit numbers
|
/// the 128-bit product of two 64-bit numbers
|
||||||
struct uint128_parts
|
struct uint128_parts
|
||||||
{
|
{
|
||||||
@@ -68,14 +87,19 @@ inline uint128_parts full_multiplication(std::uint64_t a, std::uint64_t b) noexc
|
|||||||
|
|
||||||
/// eight bytes as a little-endian word (compilers fold this into one load on
|
/// eight bytes as a little-endian word (compilers fold this into one load on
|
||||||
/// little-endian targets)
|
/// little-endian targets)
|
||||||
inline std::uint64_t read_eight_bytes(const char* p) noexcept
|
inline std::uint64_t read_eight_bytes(const unsigned char* b) noexcept
|
||||||
{
|
{
|
||||||
const auto* b = reinterpret_cast<const unsigned char*>(p); // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast)
|
|
||||||
return static_cast<std::uint64_t>(b[0]) | (static_cast<std::uint64_t>(b[1]) << 8u)
|
return static_cast<std::uint64_t>(b[0]) | (static_cast<std::uint64_t>(b[1]) << 8u)
|
||||||
| (static_cast<std::uint64_t>(b[2]) << 16u) | (static_cast<std::uint64_t>(b[3]) << 24u)
|
| (static_cast<std::uint64_t>(b[2]) << 16u) | (static_cast<std::uint64_t>(b[3]) << 24u)
|
||||||
| (static_cast<std::uint64_t>(b[4]) << 32u) | (static_cast<std::uint64_t>(b[5]) << 40u)
|
| (static_cast<std::uint64_t>(b[4]) << 32u) | (static_cast<std::uint64_t>(b[5]) << 40u)
|
||||||
| (static_cast<std::uint64_t>(b[6]) << 48u) | (static_cast<std::uint64_t>(b[7]) << 56u);
|
| (static_cast<std::uint64_t>(b[6]) << 48u) | (static_cast<std::uint64_t>(b[7]) << 56u);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// eight bytes as a little-endian word
|
||||||
|
inline std::uint64_t read_eight_bytes(const char* p) noexcept
|
||||||
|
{
|
||||||
|
return read_eight_bytes(reinterpret_cast<const unsigned char*>(p)); // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast)
|
||||||
|
}
|
||||||
|
|
||||||
} // namespace detail
|
} // namespace detail
|
||||||
NLOHMANN_JSON_NAMESPACE_END
|
NLOHMANN_JSON_NAMESPACE_END
|
||||||
|
|||||||
@@ -27,6 +27,7 @@
|
|||||||
#include <nlohmann/detail/meta/identity_tag.hpp>
|
#include <nlohmann/detail/meta/identity_tag.hpp>
|
||||||
#include <nlohmann/detail/meta/std_fs.hpp>
|
#include <nlohmann/detail/meta/std_fs.hpp>
|
||||||
#include <nlohmann/detail/meta/type_traits.hpp>
|
#include <nlohmann/detail/meta/type_traits.hpp>
|
||||||
|
#include <nlohmann/detail/meta/logic.hpp>
|
||||||
#include <nlohmann/detail/string_concat.hpp>
|
#include <nlohmann/detail/string_concat.hpp>
|
||||||
#include <nlohmann/detail/value_t.hpp>
|
#include <nlohmann/detail/value_t.hpp>
|
||||||
|
|
||||||
@@ -210,29 +211,62 @@ inline void from_json(const BasicJsonType& j, std::valarray<T>& l)
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// element is not itself a C array: read it directly
|
|
||||||
template<typename BasicJsonType, typename T>
|
|
||||||
auto from_json_c_array_element(const BasicJsonType& j, T& e)
|
|
||||||
-> decltype(e = j.template get<T>(), void())
|
|
||||||
{
|
|
||||||
e = j.template get<T>();
|
|
||||||
}
|
|
||||||
|
|
||||||
// element is itself a C array: recurse one dimension at a time, so any rank is supported
|
|
||||||
template<typename BasicJsonType, typename T, std::size_t N>
|
template<typename BasicJsonType, typename T, std::size_t N>
|
||||||
void from_json_c_array_element(const BasicJsonType& j, T (&arr)[N]) // NOLINT(cppcoreguidelines-avoid-c-arrays,hicpp-avoid-c-arrays,modernize-avoid-c-arrays)
|
auto from_json(const BasicJsonType& j, T (&arr)[N]) // NOLINT(cppcoreguidelines-avoid-c-arrays,hicpp-avoid-c-arrays,modernize-avoid-c-arrays)
|
||||||
|
-> decltype(j.template get<T>(), void())
|
||||||
{
|
{
|
||||||
for (std::size_t i = 0; i < N; ++i)
|
for (std::size_t i = 0; i < N; ++i)
|
||||||
{
|
{
|
||||||
from_json_c_array_element(j.at(i), arr[i]);
|
arr[i] = j.at(i).template get<T>();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
template<typename BasicJsonType, typename T, std::size_t N>
|
template<typename BasicJsonType, typename T, std::size_t N1, std::size_t N2>
|
||||||
auto from_json(const BasicJsonType& j, T (&arr)[N]) // NOLINT(cppcoreguidelines-avoid-c-arrays,hicpp-avoid-c-arrays,modernize-avoid-c-arrays)
|
auto from_json(const BasicJsonType& j, T (&arr)[N1][N2]) // NOLINT(cppcoreguidelines-avoid-c-arrays,hicpp-avoid-c-arrays,modernize-avoid-c-arrays)
|
||||||
-> decltype(j.template get<typename std::remove_all_extents<T>::type>(), void())
|
-> decltype(j.template get<T>(), void())
|
||||||
{
|
{
|
||||||
from_json_c_array_element(j, arr);
|
for (std::size_t i1 = 0; i1 < N1; ++i1)
|
||||||
|
{
|
||||||
|
for (std::size_t i2 = 0; i2 < N2; ++i2)
|
||||||
|
{
|
||||||
|
arr[i1][i2] = j.at(i1).at(i2).template get<T>();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
template<typename BasicJsonType, typename T, std::size_t N1, std::size_t N2, std::size_t N3>
|
||||||
|
auto from_json(const BasicJsonType& j, T (&arr)[N1][N2][N3]) // NOLINT(cppcoreguidelines-avoid-c-arrays,hicpp-avoid-c-arrays,modernize-avoid-c-arrays)
|
||||||
|
-> decltype(j.template get<T>(), void())
|
||||||
|
{
|
||||||
|
for (std::size_t i1 = 0; i1 < N1; ++i1)
|
||||||
|
{
|
||||||
|
for (std::size_t i2 = 0; i2 < N2; ++i2)
|
||||||
|
{
|
||||||
|
for (std::size_t i3 = 0; i3 < N3; ++i3)
|
||||||
|
{
|
||||||
|
arr[i1][i2][i3] = j.at(i1).at(i2).at(i3).template get<T>();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
template<typename BasicJsonType, typename T, std::size_t N1, std::size_t N2, std::size_t N3, std::size_t N4>
|
||||||
|
auto from_json(const BasicJsonType& j, T (&arr)[N1][N2][N3][N4]) // NOLINT(cppcoreguidelines-avoid-c-arrays,hicpp-avoid-c-arrays,modernize-avoid-c-arrays)
|
||||||
|
-> decltype(j.template get<T>(), void())
|
||||||
|
{
|
||||||
|
for (std::size_t i1 = 0; i1 < N1; ++i1)
|
||||||
|
{
|
||||||
|
for (std::size_t i2 = 0; i2 < N2; ++i2)
|
||||||
|
{
|
||||||
|
for (std::size_t i3 = 0; i3 < N3; ++i3)
|
||||||
|
{
|
||||||
|
for (std::size_t i4 = 0; i4 < N4; ++i4)
|
||||||
|
{
|
||||||
|
arr[i1][i2][i3][i4] = j.at(i1).at(i2).at(i3).at(i4).template get<T>();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
template<typename BasicJsonType>
|
template<typename BasicJsonType>
|
||||||
@@ -252,33 +286,20 @@ auto from_json_array_impl(const BasicJsonType& j, std::array<T, N>& arr,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// reserve() is called through this pair (modeled on from_json_object_reserve)
|
|
||||||
// so from_json_array_impl below has a single body for both ConstructibleArrayType
|
|
||||||
// that support reserve() and those that don't.
|
|
||||||
template<typename ConstructibleArrayType>
|
|
||||||
auto from_json_array_reserve(ConstructibleArrayType& arr, typename ConstructibleArrayType::size_type size, priority_tag<1> /*unused*/)
|
|
||||||
-> decltype(arr.reserve(size), void())
|
|
||||||
{
|
|
||||||
arr.reserve(size);
|
|
||||||
}
|
|
||||||
|
|
||||||
template<typename ConstructibleArrayType>
|
|
||||||
void from_json_array_reserve(ConstructibleArrayType& /*arr*/, std::size_t /*size*/, priority_tag<0> /*unused*/)
|
|
||||||
{}
|
|
||||||
|
|
||||||
template<typename BasicJsonType, typename ConstructibleArrayType,
|
template<typename BasicJsonType, typename ConstructibleArrayType,
|
||||||
enable_if_t<
|
enable_if_t<
|
||||||
std::is_assignable<ConstructibleArrayType&, ConstructibleArrayType>::value,
|
std::is_assignable<ConstructibleArrayType&, ConstructibleArrayType>::value,
|
||||||
int> = 0>
|
int> = 0>
|
||||||
auto from_json_array_impl(const BasicJsonType& j, ConstructibleArrayType& arr, priority_tag<1> /*unused*/)
|
auto from_json_array_impl(const BasicJsonType& j, ConstructibleArrayType& arr, priority_tag<1> /*unused*/)
|
||||||
-> decltype(
|
-> decltype(
|
||||||
|
arr.reserve(std::declval<typename ConstructibleArrayType::size_type>()),
|
||||||
j.template get<typename ConstructibleArrayType::value_type>(),
|
j.template get<typename ConstructibleArrayType::value_type>(),
|
||||||
void())
|
void())
|
||||||
{
|
{
|
||||||
using std::end;
|
using std::end;
|
||||||
|
|
||||||
ConstructibleArrayType ret;
|
ConstructibleArrayType ret;
|
||||||
from_json_array_reserve(ret, j.size(), priority_tag<1> {});
|
ret.reserve(j.size());
|
||||||
std::transform(j.begin(), j.end(),
|
std::transform(j.begin(), j.end(),
|
||||||
std::inserter(ret, end(ret)), [](const BasicJsonType & i)
|
std::inserter(ret, end(ret)), [](const BasicJsonType & i)
|
||||||
{
|
{
|
||||||
@@ -289,6 +310,27 @@ auto from_json_array_impl(const BasicJsonType& j, ConstructibleArrayType& arr, p
|
|||||||
arr = std::move(ret);
|
arr = std::move(ret);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
template<typename BasicJsonType, typename ConstructibleArrayType,
|
||||||
|
enable_if_t<
|
||||||
|
std::is_assignable<ConstructibleArrayType&, ConstructibleArrayType>::value,
|
||||||
|
int> = 0>
|
||||||
|
inline void from_json_array_impl(const BasicJsonType& j, ConstructibleArrayType& arr,
|
||||||
|
priority_tag<0> /*unused*/)
|
||||||
|
{
|
||||||
|
using std::end;
|
||||||
|
|
||||||
|
ConstructibleArrayType ret;
|
||||||
|
std::transform(
|
||||||
|
j.begin(), j.end(), std::inserter(ret, end(ret)),
|
||||||
|
[](const BasicJsonType & i)
|
||||||
|
{
|
||||||
|
// get<BasicJsonType>() returns *this, this won't call a from_json
|
||||||
|
// method when value_type is BasicJsonType
|
||||||
|
return i.template get<typename ConstructibleArrayType::value_type>();
|
||||||
|
});
|
||||||
|
arr = std::move(ret);
|
||||||
|
}
|
||||||
|
|
||||||
template < typename BasicJsonType, typename ConstructibleArrayType,
|
template < typename BasicJsonType, typename ConstructibleArrayType,
|
||||||
enable_if_t <
|
enable_if_t <
|
||||||
is_constructible_array_type<BasicJsonType, ConstructibleArrayType>::value&&
|
is_constructible_array_type<BasicJsonType, ConstructibleArrayType>::value&&
|
||||||
@@ -391,7 +433,9 @@ inline void from_json(const BasicJsonType& j, ConstructibleObjectType& obj)
|
|||||||
}
|
}
|
||||||
|
|
||||||
// overload for arithmetic types, not chosen for basic_json template arguments
|
// overload for arithmetic types, not chosen for basic_json template arguments
|
||||||
// (BooleanType, etc.)
|
// (BooleanType, etc.); note: Is it really necessary to provide explicit
|
||||||
|
// overloads for boolean_t etc. in case of a custom BooleanType which is not
|
||||||
|
// an arithmetic type?
|
||||||
template < typename BasicJsonType, typename ArithmeticType,
|
template < typename BasicJsonType, typename ArithmeticType,
|
||||||
enable_if_t <
|
enable_if_t <
|
||||||
std::is_arithmetic<ArithmeticType>::value&&
|
std::is_arithmetic<ArithmeticType>::value&&
|
||||||
@@ -487,7 +531,7 @@ inline void from_json_tuple_impl(const BasicJsonType& j, std::pair<A1, A2>& p, p
|
|||||||
template<typename BasicJsonType, typename... Args>
|
template<typename BasicJsonType, typename... Args>
|
||||||
std::tuple<Args...> from_json_tuple_impl(const BasicJsonType& j, identity_tag<std::tuple<Args...>> /*unused*/, priority_tag<2> /*unused*/)
|
std::tuple<Args...> from_json_tuple_impl(const BasicJsonType& j, identity_tag<std::tuple<Args...>> /*unused*/, priority_tag<2> /*unused*/)
|
||||||
{
|
{
|
||||||
static_assert(conjunction<disjunction<negation<std::is_reference<Args>>, is_compatible_reference_type<const BasicJsonType&, Args>>...>::value,
|
static_assert(cxpr_and<cxpr_or<cxpr_not<std::is_reference<Args>>, is_compatible_reference_type<const BasicJsonType&, Args>>...>::value,
|
||||||
"Can not return a tuple containing references to types not contained in a Json, try Json::get_to()");
|
"Can not return a tuple containing references to types not contained in a Json, try Json::get_to()");
|
||||||
return from_json_tuple_impl_base<1, Args...>(j, index_sequence_for<Args...> {});
|
return from_json_tuple_impl_base<1, Args...>(j, index_sequence_for<Args...> {});
|
||||||
}
|
}
|
||||||
@@ -510,10 +554,10 @@ auto from_json(const BasicJsonType& j, TupleRelated&& t)
|
|||||||
return from_json_tuple_impl(j, std::forward<TupleRelated>(t), priority_tag<3> {});
|
return from_json_tuple_impl(j, std::forward<TupleRelated>(t), priority_tag<3> {});
|
||||||
}
|
}
|
||||||
|
|
||||||
// shared body for std::map/std::unordered_map with a non-string Key: both
|
template < typename BasicJsonType, typename Key, typename Value, typename Compare, typename Allocator,
|
||||||
// containers are read from an array of [key, value] pairs the same way
|
typename = enable_if_t < !std::is_constructible <
|
||||||
template<typename BasicJsonType, typename MapType>
|
typename BasicJsonType::string_t, Key >::value >>
|
||||||
void from_json_pair_array_to_map(const BasicJsonType& j, MapType& m)
|
inline void from_json(const BasicJsonType& j, std::map<Key, Value, Compare, Allocator>& m)
|
||||||
{
|
{
|
||||||
if (JSON_HEDLEY_UNLIKELY(!j.is_array()))
|
if (JSON_HEDLEY_UNLIKELY(!j.is_array()))
|
||||||
{
|
{
|
||||||
@@ -526,29 +570,33 @@ void from_json_pair_array_to_map(const BasicJsonType& j, MapType& m)
|
|||||||
{
|
{
|
||||||
JSON_THROW(type_error::create(302, concat("type must be array, but is ", p.type_name()), &p));
|
JSON_THROW(type_error::create(302, concat("type must be array, but is ", p.type_name()), &p));
|
||||||
}
|
}
|
||||||
m.emplace(p.at(0).template get<typename MapType::key_type>(), p.at(1).template get<typename MapType::mapped_type>());
|
m.emplace(p.at(0).template get<Key>(), p.at(1).template get<Value>());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
template < typename BasicJsonType, typename Key, typename Value, typename Compare, typename Allocator,
|
|
||||||
typename = enable_if_t < !std::is_constructible <
|
|
||||||
typename BasicJsonType::string_t, Key >::value >>
|
|
||||||
void from_json(const BasicJsonType& j, std::map<Key, Value, Compare, Allocator>& m)
|
|
||||||
{
|
|
||||||
from_json_pair_array_to_map(j, m);
|
|
||||||
}
|
|
||||||
|
|
||||||
template < typename BasicJsonType, typename Key, typename Value, typename Hash, typename KeyEqual, typename Allocator,
|
template < typename BasicJsonType, typename Key, typename Value, typename Hash, typename KeyEqual, typename Allocator,
|
||||||
typename = enable_if_t < !std::is_constructible <
|
typename = enable_if_t < !std::is_constructible <
|
||||||
typename BasicJsonType::string_t, Key >::value >>
|
typename BasicJsonType::string_t, Key >::value >>
|
||||||
void from_json(const BasicJsonType& j, std::unordered_map<Key, Value, Hash, KeyEqual, Allocator>& m)
|
inline void from_json(const BasicJsonType& j, std::unordered_map<Key, Value, Hash, KeyEqual, Allocator>& m)
|
||||||
{
|
{
|
||||||
from_json_pair_array_to_map(j, m);
|
if (JSON_HEDLEY_UNLIKELY(!j.is_array()))
|
||||||
|
{
|
||||||
|
JSON_THROW(type_error::create(302, concat("type must be array, but is ", j.type_name()), &j));
|
||||||
|
}
|
||||||
|
m.clear();
|
||||||
|
for (const auto& p : j)
|
||||||
|
{
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(!p.is_array()))
|
||||||
|
{
|
||||||
|
JSON_THROW(type_error::create(302, concat("type must be array, but is ", p.type_name()), &p));
|
||||||
|
}
|
||||||
|
m.emplace(p.at(0).template get<Key>(), p.at(1).template get<Value>());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#if JSON_HAS_FILESYSTEM || JSON_HAS_EXPERIMENTAL_FILESYSTEM
|
#if JSON_HAS_FILESYSTEM || JSON_HAS_EXPERIMENTAL_FILESYSTEM
|
||||||
|
|
||||||
// Workaround for MSVC 19.51 (and possibly later): in large cpp files, the compiler may fail to resolve with generic has_from_json (issue #4996)
|
// Workaround for MSVC 19.51 (and possibly later): in large in large cpp files, the compiler may fail to resolve with generic has_from_json (issue #4996)
|
||||||
template<typename BasicJsonType>
|
template<typename BasicJsonType>
|
||||||
struct has_from_json<BasicJsonType, std_fs::path, void> : std::true_type {};
|
struct has_from_json<BasicJsonType, std_fs::path, void> : std::true_type {};
|
||||||
|
|
||||||
|
|||||||
@@ -178,7 +178,7 @@ struct external_constructor<value_t::array>
|
|||||||
|
|
||||||
template < typename BasicJsonType, typename CompatibleArrayType,
|
template < typename BasicJsonType, typename CompatibleArrayType,
|
||||||
enable_if_t < !std::is_same<CompatibleArrayType, typename BasicJsonType::array_t>::value
|
enable_if_t < !std::is_same<CompatibleArrayType, typename BasicJsonType::array_t>::value
|
||||||
#if JSON_HAS_RANGE_VIEW_CONVERSION
|
#if JSON_HAS_RANGES && !defined(__MINGW32__)
|
||||||
&& !is_compatible_range_view<CompatibleArrayType>::value
|
&& !is_compatible_range_view<CompatibleArrayType>::value
|
||||||
#endif
|
#endif
|
||||||
, int > = 0 >
|
, int > = 0 >
|
||||||
@@ -222,7 +222,9 @@ struct external_constructor<value_t::array>
|
|||||||
j.assert_invariant();
|
j.assert_invariant();
|
||||||
}
|
}
|
||||||
|
|
||||||
#if JSON_HAS_RANGE_VIEW_CONVERSION
|
// std::ranges does not work properly on MinGW due to incomplete C++20 support
|
||||||
|
// see https://github.com/nlohmann/json/issues/4916
|
||||||
|
#if JSON_HAS_RANGES && !defined(__MINGW32__)
|
||||||
template<typename BasicJsonType, typename CompatibleArrayType,
|
template<typename BasicJsonType, typename CompatibleArrayType,
|
||||||
enable_if_t<is_compatible_range_view<std::remove_cvref_t<CompatibleArrayType>>::value, int> = 0>
|
enable_if_t<is_compatible_range_view<std::remove_cvref_t<CompatibleArrayType>>::value, int> = 0>
|
||||||
static void construct(BasicJsonType& j, CompatibleArrayType && arr)
|
static void construct(BasicJsonType& j, CompatibleArrayType && arr)
|
||||||
@@ -292,9 +294,7 @@ void to_json(BasicJsonType& j, const std::optional<T>& opt) noexcept(std::is_not
|
|||||||
{
|
{
|
||||||
if (opt.has_value())
|
if (opt.has_value())
|
||||||
{
|
{
|
||||||
// explicit construction, as the conversion from a basic_json with a different
|
j = *opt;
|
||||||
// string type is explicit if JSON_USE_IMPLICIT_CONVERSIONS is 0 (#2649)
|
|
||||||
j = BasicJsonType(*opt);
|
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
@@ -382,7 +382,7 @@ template < typename BasicJsonType, typename CompatibleArrayType,
|
|||||||
!std::is_same<typename BasicJsonType::binary_t, CompatibleArrayType>::value&&
|
!std::is_same<typename BasicJsonType::binary_t, CompatibleArrayType>::value&&
|
||||||
!is_compatible_binary_type<BasicJsonType, CompatibleArrayType>::value&&
|
!is_compatible_binary_type<BasicJsonType, CompatibleArrayType>::value&&
|
||||||
!is_basic_json<CompatibleArrayType>::value
|
!is_basic_json<CompatibleArrayType>::value
|
||||||
#if JSON_HAS_RANGE_VIEW_CONVERSION
|
#if JSON_HAS_RANGES && !defined(__MINGW32__)
|
||||||
&& !is_compatible_range_view<CompatibleArrayType>::value
|
&& !is_compatible_range_view<CompatibleArrayType>::value
|
||||||
#endif
|
#endif
|
||||||
,
|
,
|
||||||
@@ -392,7 +392,7 @@ inline void to_json(BasicJsonType& j, const CompatibleArrayType& arr)
|
|||||||
external_constructor<value_t::array>::construct(j, arr);
|
external_constructor<value_t::array>::construct(j, arr);
|
||||||
}
|
}
|
||||||
|
|
||||||
#if JSON_HAS_RANGE_VIEW_CONVERSION
|
#if JSON_HAS_RANGES && !defined(__MINGW32__)
|
||||||
template < typename BasicJsonType, typename T,
|
template < typename BasicJsonType, typename T,
|
||||||
enable_if_t < is_compatible_range_view<std::remove_cvref_t<T>>::value
|
enable_if_t < is_compatible_range_view<std::remove_cvref_t<T>>::value
|
||||||
&& !is_compatible_string_type<BasicJsonType, std::remove_cvref_t<T>>::value
|
&& !is_compatible_string_type<BasicJsonType, std::remove_cvref_t<T>>::value
|
||||||
|
|||||||
@@ -286,27 +286,6 @@ class other_error : public exception
|
|||||||
other_error(int id_, const char* what_arg) : exception(id_, what_arg) {}
|
other_error(int id_, const char* what_arg) : exception(id_, what_arg) {}
|
||||||
};
|
};
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief helper function to call JSON_THROW from a template
|
|
||||||
@note JSON_THROW is a macro that, depending on the JSON_THROW_USER /
|
|
||||||
JSON_TRY_USER / JSON_NOEXCEPTION configuration, may expand to code
|
|
||||||
that does not reference its argument (e.g. `std::abort()`), which
|
|
||||||
would trigger a compilation error if the argument's type depends on
|
|
||||||
a template parameter that is otherwise unused. Wrapping the call in
|
|
||||||
a templated function avoids this and gives the compiler a single
|
|
||||||
place to see the (possibly unused) parameter.
|
|
||||||
*/
|
|
||||||
template<typename ExceptionType>
|
|
||||||
void templated_json_throw(ExceptionType exception)
|
|
||||||
{
|
|
||||||
JSON_THROW(exception);
|
|
||||||
|
|
||||||
// JSON_THROW may expand to code that discards its argument (e.g. when
|
|
||||||
// exceptions are disabled) - the cast below avoids an unused-parameter
|
|
||||||
// warning with -Werror in that case
|
|
||||||
(void)exception;
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace detail
|
} // namespace detail
|
||||||
NLOHMANN_JSON_NAMESPACE_END
|
NLOHMANN_JSON_NAMESPACE_END
|
||||||
|
|
||||||
|
|||||||
@@ -31,7 +31,6 @@
|
|||||||
#include <nlohmann/detail/macro_scope.hpp>
|
#include <nlohmann/detail/macro_scope.hpp>
|
||||||
#include <nlohmann/detail/meta/is_sax.hpp>
|
#include <nlohmann/detail/meta/is_sax.hpp>
|
||||||
#include <nlohmann/detail/meta/type_traits.hpp>
|
#include <nlohmann/detail/meta/type_traits.hpp>
|
||||||
#include <nlohmann/detail/output/error_handler.hpp>
|
|
||||||
#include <nlohmann/detail/string_concat.hpp>
|
#include <nlohmann/detail/string_concat.hpp>
|
||||||
#include <nlohmann/detail/string_utils.hpp>
|
#include <nlohmann/detail/string_utils.hpp>
|
||||||
#include <nlohmann/detail/value_t.hpp>
|
#include <nlohmann/detail/value_t.hpp>
|
||||||
@@ -109,16 +108,8 @@ class binary_reader
|
|||||||
@brief create a binary reader
|
@brief create a binary reader
|
||||||
|
|
||||||
@param[in] adapter input adapter to read from
|
@param[in] adapter input adapter to read from
|
||||||
@param[in] format the binary format to parse
|
|
||||||
@param[in] error_handler_ how to treat text strings and object keys that
|
|
||||||
are not well-formed UTF-8; none of the supported formats
|
|
||||||
requires a decoder to reject those, so the default is to
|
|
||||||
@ref error_handler_t::keep them unchanged, as every binary
|
|
||||||
reader did before this parameter existed
|
|
||||||
*/
|
*/
|
||||||
explicit binary_reader(InputAdapterType&& adapter, const input_format_t format = input_format_t::json,
|
explicit binary_reader(InputAdapterType&& adapter, const input_format_t format = input_format_t::json) noexcept : ia(std::move(adapter)), input_format(format)
|
||||||
const error_handler_t error_handler_ = error_handler_t::keep) noexcept
|
|
||||||
: ia(std::move(adapter)), input_format(format), error_handler(error_handler_)
|
|
||||||
{
|
{
|
||||||
(void)detail::is_sax_static_asserts<SAX, BasicJsonType> {};
|
(void)detail::is_sax_static_asserts<SAX, BasicJsonType> {};
|
||||||
}
|
}
|
||||||
@@ -437,7 +428,7 @@ class binary_reader
|
|||||||
{
|
{
|
||||||
if (get_bson_cstr_bulk(result, std::integral_constant<bool, bulk_scan> {}))
|
if (get_bson_cstr_bulk(result, std::integral_constant<bool, bulk_scan> {}))
|
||||||
{
|
{
|
||||||
return check_string_utf8(result, "key");
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
auto out = std::back_inserter(result);
|
auto out = std::back_inserter(result);
|
||||||
@@ -450,7 +441,7 @@ class binary_reader
|
|||||||
}
|
}
|
||||||
if (current == 0x00)
|
if (current == 0x00)
|
||||||
{
|
{
|
||||||
return check_string_utf8(result, "key");
|
return true;
|
||||||
}
|
}
|
||||||
*out++ = static_cast<typename string_t::value_type>(current);
|
*out++ = static_cast<typename string_t::value_type>(current);
|
||||||
}
|
}
|
||||||
@@ -531,7 +522,7 @@ class binary_reader
|
|||||||
"string"), nullptr));
|
"string"), nullptr));
|
||||||
}
|
}
|
||||||
|
|
||||||
return check_string_utf8(result, "string");
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -1158,7 +1149,7 @@ class binary_reader
|
|||||||
|
|
||||||
@return whether string creation completed
|
@return whether string creation completed
|
||||||
*/
|
*/
|
||||||
bool get_cbor_string(string_t& result, const char* context = "string")
|
bool get_cbor_string(string_t& result)
|
||||||
{
|
{
|
||||||
// number of indefinite-length strings that have been opened and not
|
// number of indefinite-length strings that have been opened and not
|
||||||
// closed yet. RFC 8949, Section 3.2.3 does not permit nesting them,
|
// closed yet. RFC 8949, Section 3.2.3 does not permit nesting them,
|
||||||
@@ -1188,7 +1179,7 @@ class binary_reader
|
|||||||
{
|
{
|
||||||
if (--open == 0)
|
if (--open == 0)
|
||||||
{
|
{
|
||||||
return check_string_utf8(result, context);
|
return true;
|
||||||
}
|
}
|
||||||
get();
|
get();
|
||||||
continue;
|
continue;
|
||||||
@@ -1201,7 +1192,7 @@ class binary_reader
|
|||||||
|
|
||||||
if (open == 0)
|
if (open == 0)
|
||||||
{
|
{
|
||||||
return check_string_utf8(result, context);
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
get();
|
get();
|
||||||
@@ -1225,7 +1216,7 @@ class binary_reader
|
|||||||
// EOF and major type 3 (text string) are left to get_cbor_string
|
// EOF and major type 3 (text string) are left to get_cbor_string
|
||||||
if (current == char_traits<char_type>::eof() || (static_cast<unsigned int>(current) & 0xE0u) == 0x60u)
|
if (current == char_traits<char_type>::eof() || (static_cast<unsigned int>(current) & 0xE0u) == 0x60u)
|
||||||
{
|
{
|
||||||
return get_cbor_string(result, "key");
|
return get_cbor_string(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
const char* found = nullptr;
|
const char* found = nullptr;
|
||||||
@@ -2013,7 +2004,7 @@ class binary_reader
|
|||||||
|
|
||||||
@return whether string creation completed
|
@return whether string creation completed
|
||||||
*/
|
*/
|
||||||
bool get_msgpack_string(string_t& result, const char* context = "string")
|
bool get_msgpack_string(string_t& result)
|
||||||
{
|
{
|
||||||
if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::msgpack, "string")))
|
if (JSON_HEDLEY_UNLIKELY(!unexpect_eof(input_format_t::msgpack, "string")))
|
||||||
{
|
{
|
||||||
@@ -2056,25 +2047,25 @@ class binary_reader
|
|||||||
case 0xBE:
|
case 0xBE:
|
||||||
case 0xBF:
|
case 0xBF:
|
||||||
{
|
{
|
||||||
return get_string(input_format_t::msgpack, static_cast<unsigned int>(current) & 0x1Fu, result) && check_string_utf8(result, context);
|
return get_string(input_format_t::msgpack, static_cast<unsigned int>(current) & 0x1Fu, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 0xD9: // str 8
|
case 0xD9: // str 8
|
||||||
{
|
{
|
||||||
std::uint8_t len{};
|
std::uint8_t len{};
|
||||||
return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result) && check_string_utf8(result, context);
|
return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 0xDA: // str 16
|
case 0xDA: // str 16
|
||||||
{
|
{
|
||||||
std::uint16_t len{};
|
std::uint16_t len{};
|
||||||
return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result) && check_string_utf8(result, context);
|
return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 0xDB: // str 32
|
case 0xDB: // str 32
|
||||||
{
|
{
|
||||||
std::uint32_t len{};
|
std::uint32_t len{};
|
||||||
return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result) && check_string_utf8(result, context);
|
return get_number(input_format_t::msgpack, len) && get_string(input_format_t::msgpack, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
default:
|
default:
|
||||||
@@ -2152,7 +2143,7 @@ class binary_reader
|
|||||||
// byte 0xC1 are left to get_msgpack_string
|
// byte 0xC1 are left to get_msgpack_string
|
||||||
if (current == char_traits<char_type>::eof())
|
if (current == char_traits<char_type>::eof())
|
||||||
{
|
{
|
||||||
return get_msgpack_string(result, "key");
|
return get_msgpack_string(result);
|
||||||
}
|
}
|
||||||
if (current <= 0x7F || current >= 0xE0)
|
if (current <= 0x7F || current >= 0xE0)
|
||||||
{
|
{
|
||||||
@@ -2168,7 +2159,7 @@ class binary_reader
|
|||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
return get_msgpack_string(result, "key");
|
return get_msgpack_string(result);
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -2414,7 +2405,7 @@ class binary_reader
|
|||||||
if (top.is_object)
|
if (top.is_object)
|
||||||
{
|
{
|
||||||
key.clear();
|
key.clear();
|
||||||
if (JSON_HEDLEY_UNLIKELY(!get_ubjson_string(key, true, "key") || !sax->key(key)))
|
if (JSON_HEDLEY_UNLIKELY(!get_ubjson_string(key) || !sax->key(key)))
|
||||||
{
|
{
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
@@ -2436,7 +2427,7 @@ class binary_reader
|
|||||||
if (top.is_object)
|
if (top.is_object)
|
||||||
{
|
{
|
||||||
key.clear();
|
key.clear();
|
||||||
if (JSON_HEDLEY_UNLIKELY(!get_ubjson_string(key, false, "key") || !sax->key(key)))
|
if (JSON_HEDLEY_UNLIKELY(!get_ubjson_string(key, false) || !sax->key(key)))
|
||||||
{
|
{
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
@@ -2504,7 +2495,7 @@ class binary_reader
|
|||||||
|
|
||||||
@return whether string creation completed
|
@return whether string creation completed
|
||||||
*/
|
*/
|
||||||
bool get_ubjson_string(string_t& result, const bool get_char = true, const char* context = "string")
|
bool get_ubjson_string(string_t& result, const bool get_char = true)
|
||||||
{
|
{
|
||||||
if (get_char)
|
if (get_char)
|
||||||
{
|
{
|
||||||
@@ -2525,31 +2516,31 @@ class binary_reader
|
|||||||
case 'U':
|
case 'U':
|
||||||
{
|
{
|
||||||
std::uint8_t len{};
|
std::uint8_t len{};
|
||||||
return get_number(input_format, len) && get_string(input_format, len, result) && check_string_utf8(result, context);
|
return get_number(input_format, len) && get_string(input_format, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'i':
|
case 'i':
|
||||||
{
|
{
|
||||||
std::int8_t len{};
|
std::int8_t len{};
|
||||||
return get_number(input_format, len) && check_ubjson_string_length(len) && get_string(input_format, len, result) && check_string_utf8(result, context);
|
return get_number(input_format, len) && check_ubjson_string_length(len) && get_string(input_format, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'I':
|
case 'I':
|
||||||
{
|
{
|
||||||
std::int16_t len{};
|
std::int16_t len{};
|
||||||
return get_number(input_format, len) && check_ubjson_string_length(len) && get_string(input_format, len, result) && check_string_utf8(result, context);
|
return get_number(input_format, len) && check_ubjson_string_length(len) && get_string(input_format, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'l':
|
case 'l':
|
||||||
{
|
{
|
||||||
std::int32_t len{};
|
std::int32_t len{};
|
||||||
return get_number(input_format, len) && check_ubjson_string_length(len) && get_string(input_format, len, result) && check_string_utf8(result, context);
|
return get_number(input_format, len) && check_ubjson_string_length(len) && get_string(input_format, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'L':
|
case 'L':
|
||||||
{
|
{
|
||||||
std::int64_t len{};
|
std::int64_t len{};
|
||||||
return get_number(input_format, len) && check_ubjson_string_length(len) && get_string(input_format, len, result) && check_string_utf8(result, context);
|
return get_number(input_format, len) && check_ubjson_string_length(len) && get_string(input_format, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'u':
|
case 'u':
|
||||||
@@ -2559,7 +2550,7 @@ class binary_reader
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
std::uint16_t len{};
|
std::uint16_t len{};
|
||||||
return get_number(input_format, len) && get_string(input_format, len, result) && check_string_utf8(result, context);
|
return get_number(input_format, len) && get_string(input_format, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'm':
|
case 'm':
|
||||||
@@ -2569,7 +2560,7 @@ class binary_reader
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
std::uint32_t len{};
|
std::uint32_t len{};
|
||||||
return get_number(input_format, len) && get_string(input_format, len, result) && check_string_utf8(result, context);
|
return get_number(input_format, len) && get_string(input_format, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'M':
|
case 'M':
|
||||||
@@ -2579,7 +2570,7 @@ class binary_reader
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
std::uint64_t len{};
|
std::uint64_t len{};
|
||||||
return get_number(input_format, len) && get_string(input_format, len, result) && check_string_utf8(result, context);
|
return get_number(input_format, len) && get_string(input_format, len, result);
|
||||||
}
|
}
|
||||||
|
|
||||||
default:
|
default:
|
||||||
@@ -4053,50 +4044,27 @@ class binary_reader
|
|||||||
const NumberType len,
|
const NumberType len,
|
||||||
string_t& result)
|
string_t& result)
|
||||||
{
|
{
|
||||||
// Strings are taken as is by default: none of CBOR (RFC 8949 §3.1
|
// get_bytes() appends to result, and CBOR indefinite-length strings
|
||||||
// leaves the choice to the decoder), MessagePack (whose spec
|
// collect all their chunks in the same result; validating only the
|
||||||
// explicitly allows a str object to contain an invalid byte
|
// newly read bytes keeps the check linear in the input size
|
||||||
// sequence), UBJSON, BJData, or BSON requires a decoder to reject
|
const std::size_t old_size = result.size();
|
||||||
// ill-formed UTF-8. Checking (and, with @ref error_handler_t::strict,
|
if (JSON_HEDLEY_UNLIKELY(!get_bytes(format, len, "string", result)))
|
||||||
// rejecting, or with `replace`/`ignore`, sanitizing) is opt-in via
|
|
||||||
// @ref error_handler, applied once the whole string (all chunks of
|
|
||||||
// an indefinite-length CBOR string included) has been assembled, by
|
|
||||||
// @ref check_string_utf8 at the call site.
|
|
||||||
return get_bytes(format, len, "string", result);
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief validate a decoded text string (value or object key) against @ref error_handler
|
|
||||||
|
|
||||||
None of the binary formats requires a decoder to reject ill-formed UTF-8
|
|
||||||
in a text string (see @ref get_string), so by default
|
|
||||||
(@ref error_handler_t::keep) this does nothing. A stricter
|
|
||||||
@ref error_handler opts into the same well-formedness check @ref
|
|
||||||
serializer::dump_escaped_impl applies when dumping a string:
|
|
||||||
@ref error_handler_t::strict rejects ill-formed input with
|
|
||||||
parse_error.113 (honoring `allow_exceptions` via @a sax), while
|
|
||||||
@ref error_handler_t::replace / @ref error_handler_t::ignore sanitize
|
|
||||||
@a result in place, using the exact same rules.
|
|
||||||
|
|
||||||
@param[in,out] result the already assembled string to check
|
|
||||||
@param[in] context further context information (for diagnostics)
|
|
||||||
@return whether @a result is acceptable (always true for `keep`)
|
|
||||||
*/
|
|
||||||
bool check_string_utf8(string_t& result, const char* context)
|
|
||||||
{
|
|
||||||
if (error_handler == error_handler_t::keep || is_valid_utf8(result))
|
|
||||||
{
|
{
|
||||||
return true;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (error_handler == error_handler_t::strict)
|
// RFC 8949 (CBOR) §3.1 and the MessagePack/BSON/UBJSON specifications
|
||||||
|
// all require text strings to be valid UTF-8; reject anything else
|
||||||
|
// right here so malformed input is caught at decode time instead of
|
||||||
|
// only surfacing later as a type_error.316 when the value is dumped
|
||||||
|
// (which would defeat allow_exceptions=false / strict discarding).
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(!is_valid_utf8(result, old_size)))
|
||||||
{
|
{
|
||||||
auto last_token = get_token_string();
|
return sax->parse_error(chars_read, get_token_string(),
|
||||||
return sax->parse_error(chars_read, last_token, parse_error::create(113, chars_read,
|
parse_error::create(113, chars_read,
|
||||||
exception_message(input_format, "invalid string: ill-formed UTF-8 byte", context), nullptr));
|
exception_message(format, "invalid string: ill-formed UTF-8 byte", "string"), nullptr));
|
||||||
}
|
}
|
||||||
|
|
||||||
result = sanitize_utf8(result, error_handler);
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -4273,9 +4241,6 @@ class binary_reader
|
|||||||
/// input format
|
/// input format
|
||||||
const input_format_t input_format = input_format_t::json;
|
const input_format_t input_format = input_format_t::json;
|
||||||
|
|
||||||
/// how to treat text strings/object keys that are not well-formed UTF-8
|
|
||||||
const error_handler_t error_handler = error_handler_t::keep;
|
|
||||||
|
|
||||||
/// the SAX parser
|
/// the SAX parser
|
||||||
json_sax_t* sax = nullptr;
|
json_sax_t* sax = nullptr;
|
||||||
|
|
||||||
|
|||||||
@@ -453,10 +453,8 @@ struct wide_string_input_helper<BaseInputAdapter, 4>
|
|||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
// get the current character; converted to an unsigned type so that
|
// get the current character
|
||||||
// a negative unit (wint_t is signed on some platforms) is not
|
const auto wc = input.get_character();
|
||||||
// mistaken for an ASCII character or for EOF
|
|
||||||
const auto wc = static_cast<std::uint32_t>(input.get_character());
|
|
||||||
|
|
||||||
if (wc <= 0x10FFFF)
|
if (wc <= 0x10FFFF)
|
||||||
{
|
{
|
||||||
@@ -524,11 +522,9 @@ struct wide_string_input_helper<BaseInputAdapter, 2>
|
|||||||
bool valid_pair = false;
|
bool valid_pair = false;
|
||||||
if (wc <= 0xDBFF && JSON_HEDLEY_UNLIKELY(!input.empty()))
|
if (wc <= 0xDBFF && JSON_HEDLEY_UNLIKELY(!input.empty()))
|
||||||
{
|
{
|
||||||
// only consume the next unit if it completes the pair
|
const auto wc2 = static_cast<unsigned int>(input.get_character());
|
||||||
const auto wc2 = static_cast<unsigned int>(*input.current);
|
|
||||||
if (0xDC00 <= wc2 && wc2 <= 0xDFFF)
|
if (0xDC00 <= wc2 && wc2 <= 0xDFFF)
|
||||||
{
|
{
|
||||||
input.get_character();
|
|
||||||
const auto charcode = 0x10000u + (((static_cast<unsigned int>(wc) & 0x3FFu) << 10u) | (wc2 & 0x3FFu));
|
const auto charcode = 0x10000u + (((static_cast<unsigned int>(wc) & 0x3FFu) << 10u) | (wc2 & 0x3FFu));
|
||||||
utf8_bytes_filled = 0;
|
utf8_bytes_filled = 0;
|
||||||
encode_utf8(charcode, [&utf8_bytes, &utf8_bytes_filled](std::uint32_t byte)
|
encode_utf8(charcode, [&utf8_bytes, &utf8_bytes_filled](std::uint32_t byte)
|
||||||
@@ -541,8 +537,7 @@ struct wide_string_input_helper<BaseInputAdapter, 2>
|
|||||||
|
|
||||||
if (!valid_pair)
|
if (!valid_pair)
|
||||||
{
|
{
|
||||||
// emit a byte that is never valid UTF-8 (see the UTF-32 case)
|
utf8_bytes[0] = static_cast<std::char_traits<char>::int_type>(wc);
|
||||||
utf8_bytes[0] = 0xFF;
|
|
||||||
utf8_bytes_filled = 1;
|
utf8_bytes_filled = 1;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -751,7 +746,7 @@ struct container_input_adapter_factory< ContainerType,
|
|||||||
{
|
{
|
||||||
// container is forwarded twice on purpose: the resulting begin/end
|
// container is forwarded twice on purpose: the resulting begin/end
|
||||||
// iterator types must match adapter_type, computed the same way
|
// iterator types must match adapter_type, computed the same way
|
||||||
// NOLINTNEXTLINE(bugprone-use-after-move,hicpp-invalid-access-moved)
|
// NOLINTNEXTLINE(bugprone-use-after-move)
|
||||||
return input_adapter(begin(std::forward<ContainerType>(container)), end(std::forward<ContainerType>(container)));
|
return input_adapter(begin(std::forward<ContainerType>(container)), end(std::forward<ContainerType>(container)));
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -941,15 +941,10 @@ class lexer : public lexer_base<BasicJsonType>
|
|||||||
case '\n':
|
case '\n':
|
||||||
case '\r':
|
case '\r':
|
||||||
case char_traits<char_type>::eof():
|
case char_traits<char_type>::eof():
|
||||||
return true;
|
|
||||||
|
|
||||||
#if !JSON_STRICT_NUL_HANDLING
|
#if !JSON_STRICT_NUL_HANDLING
|
||||||
case '\0':
|
case '\0':
|
||||||
// a NUL byte is the end of the input (see scan()),
|
|
||||||
// so leave it for scan() to see
|
|
||||||
unget();
|
|
||||||
return true;
|
|
||||||
#endif
|
#endif
|
||||||
|
return true;
|
||||||
|
|
||||||
default:
|
default:
|
||||||
break;
|
break;
|
||||||
@@ -1044,9 +1039,11 @@ class lexer : public lexer_base<BasicJsonType>
|
|||||||
token_type::parse_error otherwise
|
token_type::parse_error otherwise
|
||||||
|
|
||||||
@note The scanner is independent of the current locale: token_buffer
|
@note The scanner is independent of the current locale: token_buffer
|
||||||
always holds `.`. Only the std::strtod fallback of convert_number()
|
always holds `.`. The conversion of float and double does not use
|
||||||
depends on the locale, and it looks up the decimal point right
|
the locale either. Only the std::strtold fallback of
|
||||||
before converting (see detail::convert_float_locale_aware()).
|
convert_number() for long double formats other than binary64
|
||||||
|
depends on it, and it looks up the decimal point right before
|
||||||
|
converting (see detail::convert_float_locale_aware()).
|
||||||
*/
|
*/
|
||||||
token_type scan_number() // lgtm [cpp/use-of-goto] `goto` is used in this function to implement the number-parsing state machine described above. By design, any finite input will eventually reach the "done" state or return token_type::parse_error. In each intermediate state, 1 byte of the input is appended to the token_buffer vector, and only the already initialized variables token_buffer, number_type, and error_message are manipulated.
|
token_type scan_number() // lgtm [cpp/use-of-goto] `goto` is used in this function to implement the number-parsing state machine described above. By design, any finite input will eventually reach the "done" state or return token_type::parse_error. In each intermediate state, 1 byte of the input is appended to the token_buffer vector, and only the already initialized variables token_buffer, number_type, and error_message are manipulated.
|
||||||
{
|
{
|
||||||
@@ -1059,7 +1056,7 @@ class lexer : public lexer_base<BasicJsonType>
|
|||||||
|
|
||||||
// offset just past the last mantissa byte in token_buffer (i.e. the
|
// offset just past the last mantissa byte in token_buffer (i.e. the
|
||||||
// index of 'e'/'E', or the whole token when there is no exponent).
|
// index of 'e'/'E', or the whole token when there is no exponent).
|
||||||
// convert_number() uses it to count significant digits; npos means
|
// convert_number() uses it to split the token; npos means
|
||||||
// "not seen an exponent yet" and is resolved at scan_number_done
|
// "not seen an exponent yet" and is resolved at scan_number_done
|
||||||
std::size_t mantissa_end = std::string::npos;
|
std::size_t mantissa_end = std::string::npos;
|
||||||
|
|
||||||
@@ -1389,8 +1386,8 @@ scan_number_done:
|
|||||||
@param[in] mantissa_end offset just past the last mantissa byte in
|
@param[in] mantissa_end offset just past the last mantissa byte in
|
||||||
token_buffer (the index of 'e'/'E', or
|
token_buffer (the index of 'e'/'E', or
|
||||||
token_buffer.size() when there is no exponent);
|
token_buffer.size() when there is no exponent);
|
||||||
used to skip Clinger's fast path when it cannot
|
with decimal_point_position, it locates the parts
|
||||||
possibly succeed - see detail::mantissa_fits_clinger()
|
of a float token without scanning it again
|
||||||
*/
|
*/
|
||||||
token_type convert_number(token_type number_type, std::size_t mantissa_end)
|
token_type convert_number(token_type number_type, std::size_t mantissa_end)
|
||||||
{
|
{
|
||||||
@@ -1444,10 +1441,11 @@ scan_number_done:
|
|||||||
}
|
}
|
||||||
|
|
||||||
// this code is reached if we parse a floating-point number or if an
|
// this code is reached if we parse a floating-point number or if an
|
||||||
// integer conversion above overflowed. Prefer std::from_chars
|
// integer conversion above overflowed. float and double (and long
|
||||||
// (Eisel-Lemire, locale-independent, correctly rounded) when available;
|
// double where it is binary64) are converted by the library itself,
|
||||||
// otherwise the exact Clinger fast path (double only); otherwise the
|
// correctly rounded and independent of the locale; other long double
|
||||||
// locale-aware strtof/strtod/strtold.
|
// formats use std::from_chars when available, otherwise the
|
||||||
|
// locale-aware strtold.
|
||||||
if (convert_float_fast(num_begin, num_end, decimal_point_position, mantissa_end, value_float))
|
if (convert_float_fast(num_begin, num_end, decimal_point_position, mantissa_end, value_float))
|
||||||
{
|
{
|
||||||
return token_type::value_float;
|
return token_type::value_float;
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -12,6 +12,7 @@
|
|||||||
#include <cstdint> // uint64_t
|
#include <cstdint> // uint64_t
|
||||||
#include <cstring> // memcpy
|
#include <cstring> // memcpy
|
||||||
|
|
||||||
|
#include <nlohmann/detail/bit_ops.hpp>
|
||||||
#include <nlohmann/detail/macro_scope.hpp>
|
#include <nlohmann/detail/macro_scope.hpp>
|
||||||
|
|
||||||
// Optional SIMD backend for bulk UTF-8 validation. This is an opt-in external
|
// Optional SIMD backend for bulk UTF-8 validation. This is an opt-in external
|
||||||
@@ -69,18 +70,12 @@ inline std::size_t find_string_special(const unsigned char* data, std::size_t n)
|
|||||||
std::size_t i = 0;
|
std::size_t i = 0;
|
||||||
for (; i + 8 <= n; i += 8)
|
for (; i + 8 <= n; i += 8)
|
||||||
{
|
{
|
||||||
std::uint64_t word = 0;
|
const std::uint64_t special = swar_string_special(read_eight_bytes(data + i));
|
||||||
std::memcpy(&word, data + i, sizeof(word));
|
if (special != 0)
|
||||||
if (swar_string_special(word) != 0)
|
|
||||||
{
|
{
|
||||||
// a special byte is in this word; locate it (endian-agnostic)
|
// the lowest flagged byte is the first special one: the borrows of
|
||||||
for (std::size_t j = 0; j < 8; ++j)
|
// the subtractions can only flag bytes above a true hit
|
||||||
{
|
return i + (static_cast<std::size_t>(count_trailing_zeros(special)) / 8);
|
||||||
if (is_string_special(data[i + j]))
|
|
||||||
{
|
|
||||||
return i + j;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for (; i < n; ++i)
|
for (; i < n; ++i)
|
||||||
@@ -114,8 +109,7 @@ inline std::size_t find_ascii_copyable_run(const unsigned char* data, std::size_
|
|||||||
std::size_t i = 0;
|
std::size_t i = 0;
|
||||||
for (; i + 8 <= n; i += 8)
|
for (; i + 8 <= n; i += 8)
|
||||||
{
|
{
|
||||||
std::uint64_t v = 0;
|
const std::uint64_t v = read_eight_bytes(data + i);
|
||||||
std::memcpy(&v, data + i, sizeof(v));
|
|
||||||
const std::uint64_t q = v ^ 0x2222222222222222ull; // '"' (0x22)
|
const std::uint64_t q = v ^ 0x2222222222222222ull; // '"' (0x22)
|
||||||
const std::uint64_t b = v ^ 0x5C5C5C5C5C5C5C5Cull; // '\\' (0x5C)
|
const std::uint64_t b = v ^ 0x5C5C5C5C5C5C5C5Cull; // '\\' (0x5C)
|
||||||
const std::uint64_t d = v ^ 0x7F7F7F7F7F7F7F7Full; // DEL (0x7F)
|
const std::uint64_t d = v ^ 0x7F7F7F7F7F7F7F7Full; // DEL (0x7F)
|
||||||
@@ -126,7 +120,9 @@ inline std::size_t find_ascii_copyable_run(const unsigned char* data, std::size_
|
|||||||
| (v & high); // >= 0x80
|
| (v & high); // >= 0x80
|
||||||
if (stop != 0)
|
if (stop != 0)
|
||||||
{
|
{
|
||||||
break;
|
// the lowest flagged byte is the first one to stop at (see
|
||||||
|
// find_string_special())
|
||||||
|
return i + (static_cast<std::size_t>(count_trailing_zeros(stop)) / 8);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for (; i < n; ++i)
|
for (; i < n; ++i)
|
||||||
@@ -253,12 +249,18 @@ inline std::size_t scalar_string_bulk_run(const unsigned char* data, std::size_t
|
|||||||
{
|
{
|
||||||
break; // end of buffer, or a quote/escape/control byte
|
break; // end of buffer, or a quote/escape/control byte
|
||||||
}
|
}
|
||||||
const std::size_t seq = validate_one_utf8(data + pos, n - pos);
|
// a run of multi-byte sequences (e.g. CJK text) is validated sequence
|
||||||
if (seq == 0)
|
// by sequence without searching for the next special byte in between
|
||||||
|
do
|
||||||
{
|
{
|
||||||
break; // ill-formed or truncated: let the byte path diagnose it
|
const std::size_t seq = validate_one_utf8(data + pos, n - pos);
|
||||||
|
if (seq == 0)
|
||||||
|
{
|
||||||
|
return pos; // ill-formed or truncated: let the byte path diagnose it
|
||||||
|
}
|
||||||
|
pos += seq;
|
||||||
}
|
}
|
||||||
pos += seq;
|
while (pos < n && data[pos] >= 0x80u);
|
||||||
}
|
}
|
||||||
return pos;
|
return pos;
|
||||||
}
|
}
|
||||||
@@ -273,8 +275,7 @@ inline std::size_t find_string_delimiter(const unsigned char* data, std::size_t
|
|||||||
std::size_t i = 0;
|
std::size_t i = 0;
|
||||||
for (; i + 8 <= n; i += 8)
|
for (; i + 8 <= n; i += 8)
|
||||||
{
|
{
|
||||||
std::uint64_t v = 0;
|
const std::uint64_t v = read_eight_bytes(data + i);
|
||||||
std::memcpy(&v, data + i, sizeof(v));
|
|
||||||
const std::uint64_t q = v ^ 0x2222222222222222ull;
|
const std::uint64_t q = v ^ 0x2222222222222222ull;
|
||||||
const std::uint64_t b = v ^ 0x5C5C5C5C5C5C5C5Cull;
|
const std::uint64_t b = v ^ 0x5C5C5C5C5C5C5C5Cull;
|
||||||
const std::uint64_t hit = ((q - ones) & ~q & high)
|
const std::uint64_t hit = ((q - ones) & ~q & high)
|
||||||
@@ -282,14 +283,8 @@ inline std::size_t find_string_delimiter(const unsigned char* data, std::size_t
|
|||||||
| ((v - 0x2020202020202020ull) & ~v & high);
|
| ((v - 0x2020202020202020ull) & ~v & high);
|
||||||
if (hit != 0)
|
if (hit != 0)
|
||||||
{
|
{
|
||||||
for (std::size_t j = 0; j < 8; ++j)
|
// the lowest flagged byte is the first delimiter (see find_string_special())
|
||||||
{
|
return i + (static_cast<std::size_t>(count_trailing_zeros(hit)) / 8);
|
||||||
const unsigned char c = data[i + j];
|
|
||||||
if (c == '\"' || c == '\\' || c < 0x20u)
|
|
||||||
{
|
|
||||||
return i + j;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for (; i < n; ++i)
|
for (; i < n; ++i)
|
||||||
|
|||||||
@@ -60,11 +60,9 @@ class iter_impl // NOLINT(cppcoreguidelines-special-member-functions,hicpp-speci
|
|||||||
static_assert(is_basic_json<typename std::remove_const<BasicJsonType>::type>::value,
|
static_assert(is_basic_json<typename std::remove_const<BasicJsonType>::type>::value,
|
||||||
"iter_impl only accepts (const) basic_json");
|
"iter_impl only accepts (const) basic_json");
|
||||||
// superficial check for the LegacyBidirectionalIterator named requirement
|
// superficial check for the LegacyBidirectionalIterator named requirement
|
||||||
// note: only array_t::iterator is checked here; object_t::iterator may be
|
static_assert(std::is_base_of<std::bidirectional_iterator_tag, std::bidirectional_iterator_tag>::value
|
||||||
// a forward-only iterator as long as reverse iteration and operator--
|
&& std::is_base_of<std::bidirectional_iterator_tag, typename std::iterator_traits<typename array_t::iterator>::iterator_category>::value,
|
||||||
// are never used on it
|
"basic_json iterator assumes array and object type iterators satisfy the LegacyBidirectionalIterator named requirement.");
|
||||||
static_assert(std::is_base_of<std::bidirectional_iterator_tag, typename std::iterator_traits<typename array_t::iterator>::iterator_category>::value,
|
|
||||||
"basic_json iterator assumes array type iterators satisfy the LegacyBidirectionalIterator named requirement.");
|
|
||||||
|
|
||||||
public:
|
public:
|
||||||
/// The std::iterator class template (used as a base class to provide typedefs) is deprecated in C++17.
|
/// The std::iterator class template (used as a base class to provide typedefs) is deprecated in C++17.
|
||||||
|
|||||||
@@ -240,72 +240,6 @@ class json_pointer
|
|||||||
}
|
}
|
||||||
|
|
||||||
private:
|
private:
|
||||||
/*!
|
|
||||||
@brief result of @ref parse_array_index
|
|
||||||
|
|
||||||
@ref array_index maps each value to the corresponding parse_error/out_of_range
|
|
||||||
exception; @ref contains and @ref get_checked_or_null, which must not throw for
|
|
||||||
an out-of-range or unrepresentable index, switch on it directly instead.
|
|
||||||
*/
|
|
||||||
enum class array_index_status
|
|
||||||
{
|
|
||||||
ok, ///< @a s is a valid, representable array index
|
|
||||||
leading_zero, ///< @a s begins with '0' but has more than one character
|
|
||||||
not_a_number, ///< @a s does not begin with a digit
|
|
||||||
unresolved, ///< @a s could not be converted to an integer
|
|
||||||
exceeds_size_type ///< @a s converts to an integer that exceeds size_type
|
|
||||||
};
|
|
||||||
|
|
||||||
/*!
|
|
||||||
@param[in] s reference token to be converted into an array index
|
|
||||||
@param[out] idx the integer representation of @a s if @ref array_index_status::ok
|
|
||||||
is returned; left unchanged otherwise
|
|
||||||
|
|
||||||
@return whether @a s is a valid array index, and if not, why
|
|
||||||
|
|
||||||
@note this function never throws; @ref array_index and the callers that must not
|
|
||||||
throw (@ref contains, @ref get_checked_or_null) build on it instead of each
|
|
||||||
re-implementing the RFC 6901 digit rules and the @a size_type range check
|
|
||||||
*/
|
|
||||||
template<typename BasicJsonType>
|
|
||||||
static array_index_status parse_array_index(const string_t& s, typename BasicJsonType::size_type& idx) noexcept
|
|
||||||
{
|
|
||||||
using size_type = typename BasicJsonType::size_type;
|
|
||||||
|
|
||||||
// error condition (cf. RFC 6901, Sect. 4)
|
|
||||||
if (JSON_HEDLEY_UNLIKELY(s.size() > 1 && s[0] == '0'))
|
|
||||||
{
|
|
||||||
return array_index_status::leading_zero;
|
|
||||||
}
|
|
||||||
|
|
||||||
// error condition (cf. RFC 6901, Sect. 4)
|
|
||||||
if (JSON_HEDLEY_UNLIKELY(s.size() > 1 && !(s[0] >= '1' && s[0] <= '9')))
|
|
||||||
{
|
|
||||||
return array_index_status::not_a_number;
|
|
||||||
}
|
|
||||||
|
|
||||||
const char* p = s.data();
|
|
||||||
char* p_end = nullptr; // NOLINT(misc-const-correctness)
|
|
||||||
errno = 0; // strtoull doesn't reset errno
|
|
||||||
const unsigned long long res = std::strtoull(p, &p_end, 10); // NOLINT(runtime/int)
|
|
||||||
if (p == p_end // invalid input or empty string
|
|
||||||
|| errno == ERANGE // out of range
|
|
||||||
|| JSON_HEDLEY_UNLIKELY(static_cast<std::size_t>(p_end - p) != s.size())) // incomplete read
|
|
||||||
{
|
|
||||||
return array_index_status::unresolved;
|
|
||||||
}
|
|
||||||
|
|
||||||
// the index does not fit into size_type; on 64-bit platforms this is
|
|
||||||
// only SIZE_MAX itself (see #2203 and #5395)
|
|
||||||
if (res >= static_cast<unsigned long long>((std::numeric_limits<size_type>::max)())) // NOLINT(runtime/int)
|
|
||||||
{
|
|
||||||
return array_index_status::exceeds_size_type;
|
|
||||||
}
|
|
||||||
|
|
||||||
idx = static_cast<size_type>(res);
|
|
||||||
return array_index_status::ok;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@param[in] s reference token to be converted into an array index
|
@param[in] s reference token to be converted into an array index
|
||||||
|
|
||||||
@@ -319,25 +253,39 @@ class json_pointer
|
|||||||
template<typename BasicJsonType>
|
template<typename BasicJsonType>
|
||||||
static typename BasicJsonType::size_type array_index(const string_t& s)
|
static typename BasicJsonType::size_type array_index(const string_t& s)
|
||||||
{
|
{
|
||||||
typename BasicJsonType::size_type idx{};
|
using size_type = typename BasicJsonType::size_type;
|
||||||
switch (parse_array_index<BasicJsonType>(s, idx))
|
|
||||||
|
// error condition (cf. RFC 6901, Sect. 4)
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(s.size() > 1 && s[0] == '0'))
|
||||||
{
|
{
|
||||||
// the branches differ in their messages, not after JSON_THROW's expansion
|
JSON_THROW(detail::parse_error::create(106, 0, detail::concat("array index '", s, "' must not begin with '0'"), nullptr));
|
||||||
// NOLINTNEXTLINE(bugprone-branch-clone)
|
|
||||||
case array_index_status::leading_zero:
|
|
||||||
JSON_THROW(detail::parse_error::create(106, 0, detail::concat("array index '", s, "' must not begin with '0'"), nullptr));
|
|
||||||
case array_index_status::not_a_number:
|
|
||||||
JSON_THROW(detail::parse_error::create(109, 0, detail::concat("array index '", s, "' is not a number"), nullptr));
|
|
||||||
case array_index_status::unresolved:
|
|
||||||
JSON_THROW(detail::out_of_range::create(404, detail::concat("unresolved reference token '", s, "'"), nullptr));
|
|
||||||
case array_index_status::exceeds_size_type:
|
|
||||||
JSON_THROW(detail::out_of_range::create(410, detail::concat("array index ", s, " exceeds size_type"), nullptr));
|
|
||||||
case array_index_status::ok:
|
|
||||||
default:
|
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return idx;
|
// error condition (cf. RFC 6901, Sect. 4)
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(s.size() > 1 && !(s[0] >= '1' && s[0] <= '9')))
|
||||||
|
{
|
||||||
|
JSON_THROW(detail::parse_error::create(109, 0, detail::concat("array index '", s, "' is not a number"), nullptr));
|
||||||
|
}
|
||||||
|
|
||||||
|
const char* p = s.data();
|
||||||
|
char* p_end = nullptr; // NOLINT(misc-const-correctness)
|
||||||
|
errno = 0; // strtoull doesn't reset errno
|
||||||
|
const unsigned long long res = std::strtoull(p, &p_end, 10); // NOLINT(runtime/int)
|
||||||
|
if (p == p_end // invalid input or empty string
|
||||||
|
|| errno == ERANGE // out of range
|
||||||
|
|| JSON_HEDLEY_UNLIKELY(static_cast<std::size_t>(p_end - p) != s.size())) // incomplete read
|
||||||
|
{
|
||||||
|
JSON_THROW(detail::out_of_range::create(404, detail::concat("unresolved reference token '", s, "'"), nullptr));
|
||||||
|
}
|
||||||
|
|
||||||
|
// the index does not fit into size_type; on 64-bit platforms this is
|
||||||
|
// only SIZE_MAX itself (see #2203 and #5395)
|
||||||
|
if (res >= static_cast<unsigned long long>((std::numeric_limits<size_type>::max)())) // NOLINT(runtime/int)
|
||||||
|
{
|
||||||
|
JSON_THROW(detail::out_of_range::create(410, detail::concat("array index ", s, " exceeds size_type"), nullptr));
|
||||||
|
}
|
||||||
|
|
||||||
|
return static_cast<size_type>(res);
|
||||||
}
|
}
|
||||||
|
|
||||||
JSON_PRIVATE_UNLESS_TESTED:
|
JSON_PRIVATE_UNLESS_TESTED:
|
||||||
@@ -588,10 +536,6 @@ class json_pointer
|
|||||||
@return const reference to the JSON value pointed to by the JSON
|
@return const reference to the JSON value pointed to by the JSON
|
||||||
pointer
|
pointer
|
||||||
|
|
||||||
@pre Every object key and array index the pointer refers to exists.
|
|
||||||
Like the const operator[] for keys and indices, a missing one is
|
|
||||||
undefined behavior, guarded by a runtime assertion.
|
|
||||||
|
|
||||||
@throw parse_error.106 if an array index begins with '0'
|
@throw parse_error.106 if an array index begins with '0'
|
||||||
@throw parse_error.109 if an array index was not a number
|
@throw parse_error.109 if an array index was not a number
|
||||||
@throw out_of_range.402 if the array index '-' is used
|
@throw out_of_range.402 if the array index '-' is used
|
||||||
@@ -606,8 +550,7 @@ class json_pointer
|
|||||||
{
|
{
|
||||||
case detail::value_t::object:
|
case detail::value_t::object:
|
||||||
{
|
{
|
||||||
// use unchecked object access; the const operator[]
|
// use unchecked object access
|
||||||
// asserts that the key exists
|
|
||||||
ptr = &ptr->operator[](reference_token);
|
ptr = &ptr->operator[](reference_token);
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -620,8 +563,7 @@ class json_pointer
|
|||||||
JSON_THROW(detail::out_of_range::create(402, detail::concat("array index '-' (", std::to_string(ptr->m_data.m_value.array->size()), ") is out of range"), ptr));
|
JSON_THROW(detail::out_of_range::create(402, detail::concat("array index '-' (", std::to_string(ptr->m_data.m_value.array->size()), ") is out of range"), ptr));
|
||||||
}
|
}
|
||||||
|
|
||||||
// use unchecked array access; the const operator[]
|
// use unchecked array access
|
||||||
// asserts that the index exists
|
|
||||||
ptr = &ptr->operator[](array_index<BasicJsonType>(reference_token));
|
ptr = &ptr->operator[](array_index<BasicJsonType>(reference_token));
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -642,6 +584,63 @@ class json_pointer
|
|||||||
return *ptr;
|
return *ptr;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@throw parse_error.106 if an array index begins with '0'
|
||||||
|
@throw parse_error.109 if an array index was not a number
|
||||||
|
@throw out_of_range.402 if the array index '-' is used
|
||||||
|
@throw out_of_range.404 if the JSON pointer can not be resolved
|
||||||
|
*/
|
||||||
|
template<typename BasicJsonType>
|
||||||
|
const BasicJsonType& get_checked(const BasicJsonType* ptr) const
|
||||||
|
{
|
||||||
|
for (const auto& reference_token : reference_tokens)
|
||||||
|
{
|
||||||
|
switch (ptr->type())
|
||||||
|
{
|
||||||
|
case detail::value_t::object:
|
||||||
|
{
|
||||||
|
// note: at performs range check
|
||||||
|
ptr = &ptr->at(reference_token);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
case detail::value_t::array:
|
||||||
|
{
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(reference_token == "-"))
|
||||||
|
{
|
||||||
|
// "-" always fails the range check
|
||||||
|
JSON_THROW(detail::out_of_range::create(402, detail::concat(
|
||||||
|
"array index '-' (", std::to_string(ptr->m_data.m_value.array->size()),
|
||||||
|
") is out of range"), ptr));
|
||||||
|
}
|
||||||
|
|
||||||
|
const auto idx = array_index<BasicJsonType>(reference_token);
|
||||||
|
// Bounds check before access to avoid exception with JSON_NOEXCEPTION
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(idx >= ptr->m_data.m_value.array->size()))
|
||||||
|
{
|
||||||
|
JSON_THROW(detail::out_of_range::create(401, detail::concat(
|
||||||
|
"array index ", std::to_string(idx), " is out of range"), ptr));
|
||||||
|
}
|
||||||
|
ptr = &ptr->operator[](idx);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
case detail::value_t::null:
|
||||||
|
case detail::value_t::string:
|
||||||
|
case detail::value_t::boolean:
|
||||||
|
case detail::value_t::number_integer:
|
||||||
|
case detail::value_t::number_unsigned:
|
||||||
|
case detail::value_t::number_float:
|
||||||
|
case detail::value_t::binary:
|
||||||
|
case detail::value_t::discarded:
|
||||||
|
default:
|
||||||
|
JSON_THROW(detail::out_of_range::create(404, detail::concat("unresolved reference token '", reference_token, "'"), ptr));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return *ptr;
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief return a pointer to the pointed to value, or `nullptr` if the
|
@brief return a pointer to the pointed to value, or `nullptr` if the
|
||||||
pointer cannot be resolved because a key is missing, an array
|
pointer cannot be resolved because a key is missing, an array
|
||||||
@@ -680,25 +679,18 @@ class json_pointer
|
|||||||
return nullptr;
|
return nullptr;
|
||||||
}
|
}
|
||||||
|
|
||||||
// a malformed index throws parse_error.106/109; an
|
// may throw parse_error.106/109 for a malformed index; an
|
||||||
// index that is syntactically valid but cannot be
|
// index that is syntactically valid but cannot be
|
||||||
// represented (out_of_range.404/410) is treated like an
|
// represented (out_of_range.404/410) is treated like an
|
||||||
// out-of-range index below
|
// out-of-range index below
|
||||||
typename BasicJsonType::size_type idx{};
|
typename BasicJsonType::size_type idx{};
|
||||||
switch (parse_array_index<BasicJsonType>(reference_token, idx))
|
JSON_TRY
|
||||||
{
|
{
|
||||||
// the branches differ in their messages, not after JSON_THROW's expansion
|
idx = array_index<BasicJsonType>(reference_token);
|
||||||
// NOLINTNEXTLINE(bugprone-branch-clone)
|
}
|
||||||
case array_index_status::leading_zero:
|
JSON_INTERNAL_CATCH (detail::out_of_range&)
|
||||||
JSON_THROW(detail::parse_error::create(106, 0, detail::concat("array index '", reference_token, "' must not begin with '0'"), nullptr));
|
{
|
||||||
case array_index_status::not_a_number:
|
return nullptr;
|
||||||
JSON_THROW(detail::parse_error::create(109, 0, detail::concat("array index '", reference_token, "' is not a number"), nullptr));
|
|
||||||
case array_index_status::unresolved:
|
|
||||||
case array_index_status::exceeds_size_type:
|
|
||||||
return nullptr;
|
|
||||||
case array_index_status::ok:
|
|
||||||
default:
|
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (JSON_HEDLEY_UNLIKELY(idx >= ptr->m_data.m_value.array->size()))
|
if (JSON_HEDLEY_UNLIKELY(idx >= ptr->m_data.m_value.array->size()))
|
||||||
@@ -726,8 +718,8 @@ class json_pointer
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@note unlike array_index(), this never throws: a malformed or unrepresentable
|
@throw parse_error.106 if an array index begins with '0'
|
||||||
array index reference token is treated like a missing key (see #5395)
|
@throw parse_error.109 if an array index was not a number
|
||||||
*/
|
*/
|
||||||
template<typename BasicJsonType>
|
template<typename BasicJsonType>
|
||||||
bool contains(const BasicJsonType* ptr) const
|
bool contains(const BasicJsonType* ptr) const
|
||||||
@@ -755,17 +747,49 @@ class json_pointer
|
|||||||
// "-" always fails the range check
|
// "-" always fails the range check
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(reference_token.empty()))
|
||||||
// any parse failure (malformed index, or one that is syntactically
|
|
||||||
// valid but not representable as size_type) means the reference
|
|
||||||
// token cannot denote an existing array element -- contains() must
|
|
||||||
// not throw (see #5395), so it is treated as "not found"
|
|
||||||
typename BasicJsonType::size_type idx{};
|
|
||||||
if (JSON_HEDLEY_UNLIKELY(parse_array_index<BasicJsonType>(reference_token, idx) != array_index_status::ok))
|
|
||||||
{
|
{
|
||||||
|
// an empty reference token is not an array index; array_index()
|
||||||
|
// would throw out_of_range.404 -- contains() must not throw (see #5395)
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(reference_token.size() == 1 && !('0' <= reference_token[0] && reference_token[0] <= '9')))
|
||||||
|
{
|
||||||
|
// invalid char
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(reference_token.size() > 1))
|
||||||
|
{
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(!('1' <= reference_token[0] && reference_token[0] <= '9')))
|
||||||
|
{
|
||||||
|
// the first char should be between '1' and '9'
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
for (std::size_t i = 1; i < reference_token.size(); i++)
|
||||||
|
{
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(!('0' <= reference_token[i] && reference_token[i] <= '9')))
|
||||||
|
{
|
||||||
|
// other char should be between '0' and '9'
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// the reference token consists only of digits at this point (cf. checks
|
||||||
|
// above); however, its numeric value might not be representable, in which
|
||||||
|
// case array_index() would throw out_of_range.404/410 -- contains() must
|
||||||
|
// not throw (see #5395), so such a reference token is treated as "not found"
|
||||||
|
errno = 0; // strtoull() does not reset errno on success
|
||||||
|
char* p_end = nullptr; // NOLINT(misc-const-correctness)
|
||||||
|
const unsigned long long magnitude = std::strtoull(reference_token.data(), &p_end, 10); // NOLINT(runtime/int)
|
||||||
|
if (JSON_HEDLEY_UNLIKELY(errno == ERANGE // the value exceeds ULLONG_MAX
|
||||||
|
|| magnitude >= static_cast<unsigned long long>((std::numeric_limits<typename BasicJsonType::size_type>::max)()))) // NOLINT(runtime/int)
|
||||||
|
{
|
||||||
|
// the array index cannot be represented as size_type
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const auto idx = array_index<BasicJsonType>(reference_token);
|
||||||
if (idx >= ptr->size())
|
if (idx >= ptr->size())
|
||||||
{
|
{
|
||||||
// index out of range
|
// index out of range
|
||||||
|
|||||||
@@ -9,6 +9,7 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include <utility> // declval, pair
|
#include <utility> // declval, pair
|
||||||
|
#include <nlohmann/detail/meta/detected.hpp>
|
||||||
#include <nlohmann/thirdparty/hedley/hedley.hpp>
|
#include <nlohmann/thirdparty/hedley/hedley.hpp>
|
||||||
|
|
||||||
// This file contains all internal macro definitions (except those affecting ABI)
|
// This file contains all internal macro definitions (except those affecting ABI)
|
||||||
@@ -139,12 +140,10 @@
|
|||||||
// libstdc++ < 11 has incomplete C++20 ranges (issue #4440)
|
// libstdc++ < 11 has incomplete C++20 ranges (issue #4440)
|
||||||
#elif defined(_GLIBCXX_RELEASE) && _GLIBCXX_RELEASE < 11
|
#elif defined(_GLIBCXX_RELEASE) && _GLIBCXX_RELEASE < 11
|
||||||
#define JSON_HAS_RANGES 0
|
#define JSON_HAS_RANGES 0
|
||||||
// clang < 16 with libstdc++ does not implement the ranges customization
|
// libc++ < 16 has incomplete C++20 ranges (issue #4440)
|
||||||
// points libstdc++ declares, so its C++20 ranges support is incomplete (issue #5161)
|
|
||||||
#elif defined(__clang__) && !defined(__apple_build_version__) \
|
#elif defined(__clang__) && !defined(__apple_build_version__) \
|
||||||
&& __clang_major__ < 16 && defined(__GLIBCXX__)
|
&& __clang_major__ < 16 && defined(__GLIBCXX__)
|
||||||
#define JSON_HAS_RANGES 0
|
#define JSON_HAS_RANGES 0
|
||||||
// libc++ < 16 has incomplete C++20 ranges (issue #4440)
|
|
||||||
#elif defined(_LIBCPP_VERSION) && _LIBCPP_VERSION < 160000
|
#elif defined(_LIBCPP_VERSION) && _LIBCPP_VERSION < 160000
|
||||||
#define JSON_HAS_RANGES 0
|
#define JSON_HAS_RANGES 0
|
||||||
// nvcc CUDA 12.0/12.1 chokes on the enable_borrowed_range variable-template
|
// nvcc CUDA 12.0/12.1 chokes on the enable_borrowed_range variable-template
|
||||||
@@ -159,18 +158,6 @@
|
|||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// std::ranges view conversion (to_json/is_compatible_array_type_impl) additionally
|
|
||||||
// needs to be disabled on MinGW, whose std::ranges support is incomplete
|
|
||||||
// (issue #4916); this macro combines both conditions so the check and its
|
|
||||||
// reason are not duplicated at every use site.
|
|
||||||
#ifndef JSON_HAS_RANGE_VIEW_CONVERSION
|
|
||||||
#if JSON_HAS_RANGES && !defined(__MINGW32__)
|
|
||||||
#define JSON_HAS_RANGE_VIEW_CONVERSION 1
|
|
||||||
#else
|
|
||||||
#define JSON_HAS_RANGE_VIEW_CONVERSION 0
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef JSON_HAS_STD_FORMAT
|
#ifndef JSON_HAS_STD_FORMAT
|
||||||
#if defined(JSON_HAS_CPP_20) && defined(__cpp_lib_format)
|
#if defined(JSON_HAS_CPP_20) && defined(__cpp_lib_format)
|
||||||
#define JSON_HAS_STD_FORMAT 1
|
#define JSON_HAS_STD_FORMAT 1
|
||||||
@@ -292,6 +279,21 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@brief function to wrap JSON_THROW_MACRO - there can be compilation errors about
|
||||||
|
there being no arguments to JSON_THROW that depend on template arguments
|
||||||
|
if this is not used to call JSON_THROW
|
||||||
|
*/
|
||||||
|
template<typename ExceptionType>
|
||||||
|
void templated_json_throw(ExceptionType exception)
|
||||||
|
{
|
||||||
|
JSON_THROW(exception);
|
||||||
|
|
||||||
|
/* JSON_THROW(exception) discards exception and aborts - void cast needed to supress
|
||||||
|
compilation error if compiled with -Werror and Wunused-parameter */
|
||||||
|
(void)exception;
|
||||||
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief macro to briefly define a mapping between an enum and JSON with exception
|
@brief macro to briefly define a mapping between an enum and JSON with exception
|
||||||
on invalid input
|
on invalid input
|
||||||
@@ -312,7 +314,7 @@
|
|||||||
return ej_pair.first == e; \
|
return ej_pair.first == e; \
|
||||||
}); \
|
}); \
|
||||||
if (it != std::end(m)) j = it->second; \
|
if (it != std::end(m)) j = it->second; \
|
||||||
else ::nlohmann::detail::templated_json_throw<nlohmann::detail::out_of_range>(nlohmann::detail::out_of_range::create(410,"enum value out of range for " #ENUM_TYPE, nullptr)); \
|
else templated_json_throw<nlohmann::detail::out_of_range>(nlohmann::detail::out_of_range::create(410,"enum value out of range for " #ENUM_TYPE, nullptr)); \
|
||||||
} \
|
} \
|
||||||
template<typename BasicJsonType> \
|
template<typename BasicJsonType> \
|
||||||
inline void from_json(const BasicJsonType& j, ENUM_TYPE& e) \
|
inline void from_json(const BasicJsonType& j, ENUM_TYPE& e) \
|
||||||
@@ -327,7 +329,7 @@
|
|||||||
return ej_pair.second == j; \
|
return ej_pair.second == j; \
|
||||||
}); \
|
}); \
|
||||||
if (it != std::end(m)) e = it->first; \
|
if (it != std::end(m)) e = it->first; \
|
||||||
else ::nlohmann::detail::templated_json_throw<nlohmann::detail::out_of_range>(nlohmann::detail::out_of_range::create(410, nlohmann::detail::concat("enum value out of range for " #ENUM_TYPE ": ", j.dump(-1, ' ', false, nlohmann::detail::error_handler_t::replace)), &j)); \
|
else templated_json_throw<nlohmann::detail::out_of_range>(nlohmann::detail::out_of_range::create(410, nlohmann::detail::concat("enum value out of range for " #ENUM_TYPE ": ", j.dump(-1, ' ', false, nlohmann::detail::error_handler_t::replace)), &j)); \
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ugly macros to avoid uglier copy-paste when specializing basic_json. They
|
// Ugly macros to avoid uglier copy-paste when specializing basic_json. They
|
||||||
@@ -872,6 +874,30 @@
|
|||||||
\
|
\
|
||||||
template<typename... T> \
|
template<typename... T> \
|
||||||
using result_of_##std_name = decltype(std_name(std::declval<T>()...)); \
|
using result_of_##std_name = decltype(std_name(std::declval<T>()...)); \
|
||||||
|
} \
|
||||||
|
\
|
||||||
|
namespace detail2 { \
|
||||||
|
struct std_name##_tag \
|
||||||
|
{ \
|
||||||
|
}; \
|
||||||
|
\
|
||||||
|
template<typename... T> \
|
||||||
|
std_name##_tag std_name(T&&...); \
|
||||||
|
\
|
||||||
|
template<typename... T> \
|
||||||
|
using result_of_##std_name = decltype(std_name(std::declval<T>()...)); \
|
||||||
|
\
|
||||||
|
template<typename... T> \
|
||||||
|
struct would_call_std_##std_name \
|
||||||
|
{ \
|
||||||
|
static constexpr auto const value = ::nlohmann::detail:: \
|
||||||
|
is_detected_exact<std_name##_tag, result_of_##std_name, T...>::value; \
|
||||||
|
}; \
|
||||||
|
} /* namespace detail2 */ \
|
||||||
|
\
|
||||||
|
template<typename... T> \
|
||||||
|
struct would_call_std_##std_name : detail2::would_call_std_##std_name<T...> \
|
||||||
|
{ \
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifndef JSON_USE_IMPLICIT_CONVERSIONS
|
#ifndef JSON_USE_IMPLICIT_CONVERSIONS
|
||||||
|
|||||||
@@ -35,14 +35,12 @@
|
|||||||
#undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
|
#undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
|
||||||
#undef JSON_HAS_THREE_WAY_COMPARISON
|
#undef JSON_HAS_THREE_WAY_COMPARISON
|
||||||
#undef JSON_HAS_RANGES
|
#undef JSON_HAS_RANGES
|
||||||
#undef JSON_HAS_RANGE_VIEW_CONVERSION
|
|
||||||
#undef JSON_HAS_STD_FORMAT
|
#undef JSON_HAS_STD_FORMAT
|
||||||
#undef JSON_HAS_STATIC_RTTI
|
#undef JSON_HAS_STATIC_RTTI
|
||||||
#undef JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON
|
#undef JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON
|
||||||
#undef JSON_BRACE_INIT_COPY_SEMANTICS
|
#undef JSON_BRACE_INIT_COPY_SEMANTICS
|
||||||
#undef JSON_PRECISE_STREAM_POSITION
|
#undef JSON_PRECISE_STREAM_POSITION
|
||||||
#undef JSON_STRICT_NUL_HANDLING
|
#undef JSON_STRICT_NUL_HANDLING
|
||||||
#undef JSON_STRICT_BINARY_UTF8
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#include <nlohmann/thirdparty/hedley/hedley_undef.hpp>
|
#include <nlohmann/thirdparty/hedley/hedley_undef.hpp>
|
||||||
|
|||||||
@@ -12,6 +12,6 @@
|
|||||||
|
|
||||||
NLOHMANN_JSON_NAMESPACE_BEGIN
|
NLOHMANN_JSON_NAMESPACE_BEGIN
|
||||||
|
|
||||||
NLOHMANN_CAN_CALL_STD_FUNC_IMPL(begin)
|
NLOHMANN_CAN_CALL_STD_FUNC_IMPL(begin);
|
||||||
|
|
||||||
NLOHMANN_JSON_NAMESPACE_END
|
NLOHMANN_JSON_NAMESPACE_END
|
||||||
|
|||||||
@@ -12,6 +12,6 @@
|
|||||||
|
|
||||||
NLOHMANN_JSON_NAMESPACE_BEGIN
|
NLOHMANN_JSON_NAMESPACE_BEGIN
|
||||||
|
|
||||||
NLOHMANN_CAN_CALL_STD_FUNC_IMPL(end)
|
NLOHMANN_CAN_CALL_STD_FUNC_IMPL(end);
|
||||||
|
|
||||||
NLOHMANN_JSON_NAMESPACE_END
|
NLOHMANN_JSON_NAMESPACE_END
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include <cstddef> // size_t
|
#include <cstdint> // size_t
|
||||||
#include <utility> // declval
|
#include <utility> // declval
|
||||||
#include <string> // string
|
#include <string> // string
|
||||||
|
|
||||||
@@ -70,6 +70,37 @@ using parse_error_function_t = decltype(std::declval<T&>().parse_error(
|
|||||||
std::declval<std::size_t>(), std::declval<const std::string&>(),
|
std::declval<std::size_t>(), std::declval<const std::string&>(),
|
||||||
std::declval<const Exception&>()));
|
std::declval<const Exception&>()));
|
||||||
|
|
||||||
|
template<typename SAX, typename BasicJsonType>
|
||||||
|
struct is_sax
|
||||||
|
{
|
||||||
|
private:
|
||||||
|
static_assert(is_basic_json<BasicJsonType>::value,
|
||||||
|
"BasicJsonType must be of type basic_json<...>");
|
||||||
|
|
||||||
|
using number_integer_t = typename BasicJsonType::number_integer_t;
|
||||||
|
using number_unsigned_t = typename BasicJsonType::number_unsigned_t;
|
||||||
|
using number_float_t = typename BasicJsonType::number_float_t;
|
||||||
|
using string_t = typename BasicJsonType::string_t;
|
||||||
|
using binary_t = typename BasicJsonType::binary_t;
|
||||||
|
using exception_t = typename BasicJsonType::exception;
|
||||||
|
|
||||||
|
public:
|
||||||
|
static constexpr bool value =
|
||||||
|
is_detected_exact<bool, null_function_t, SAX>::value &&
|
||||||
|
is_detected_exact<bool, boolean_function_t, SAX>::value &&
|
||||||
|
is_detected_exact<bool, number_integer_function_t, SAX, number_integer_t>::value &&
|
||||||
|
is_detected_exact<bool, number_unsigned_function_t, SAX, number_unsigned_t>::value &&
|
||||||
|
is_detected_exact<bool, number_float_function_t, SAX, number_float_t, string_t>::value &&
|
||||||
|
is_detected_exact<bool, string_function_t, SAX, string_t>::value &&
|
||||||
|
is_detected_exact<bool, binary_function_t, SAX, binary_t>::value &&
|
||||||
|
is_detected_exact<bool, start_object_function_t, SAX>::value &&
|
||||||
|
is_detected_exact<bool, key_function_t, SAX, string_t>::value &&
|
||||||
|
is_detected_exact<bool, end_object_function_t, SAX>::value &&
|
||||||
|
is_detected_exact<bool, start_array_function_t, SAX>::value &&
|
||||||
|
is_detected_exact<bool, end_array_function_t, SAX>::value &&
|
||||||
|
is_detected_exact<bool, parse_error_function_t, SAX, exception_t>::value;
|
||||||
|
};
|
||||||
|
|
||||||
template<typename SAX, typename BasicJsonType>
|
template<typename SAX, typename BasicJsonType>
|
||||||
struct is_sax_static_asserts
|
struct is_sax_static_asserts
|
||||||
{
|
{
|
||||||
@@ -89,6 +120,8 @@ struct is_sax_static_asserts
|
|||||||
"Missing/invalid function: bool null()");
|
"Missing/invalid function: bool null()");
|
||||||
static_assert(is_detected_exact<bool, boolean_function_t, SAX>::value,
|
static_assert(is_detected_exact<bool, boolean_function_t, SAX>::value,
|
||||||
"Missing/invalid function: bool boolean(bool)");
|
"Missing/invalid function: bool boolean(bool)");
|
||||||
|
static_assert(is_detected_exact<bool, boolean_function_t, SAX>::value,
|
||||||
|
"Missing/invalid function: bool boolean(bool)");
|
||||||
static_assert(
|
static_assert(
|
||||||
is_detected_exact<bool, number_integer_function_t, SAX,
|
is_detected_exact<bool, number_integer_function_t, SAX,
|
||||||
number_integer_t>::value,
|
number_integer_t>::value,
|
||||||
|
|||||||
@@ -0,0 +1,54 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <nlohmann/detail/macro_scope.hpp>
|
||||||
|
|
||||||
|
NLOHMANN_JSON_NAMESPACE_BEGIN
|
||||||
|
namespace detail
|
||||||
|
{
|
||||||
|
#ifdef JSON_HAS_CPP_17
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_or_impl : std::integral_constant < bool, (Booleans || ...) > {};
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_and_impl : std::integral_constant < bool, (Booleans &&...) > {};
|
||||||
|
|
||||||
|
#else
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_or_impl : std::false_type {};
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_or_impl<true, Booleans...> : std::true_type {};
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_or_impl<false, Booleans...> : cxpr_or_impl<Booleans...> {};
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_and_impl : std::true_type {};
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_and_impl<true, Booleans...> : cxpr_and_impl<Booleans...> {};
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_and_impl<false, Booleans...> : std::false_type {};
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
template<class Boolean>
|
||||||
|
struct cxpr_not : std::integral_constant < bool, !Boolean::value > {};
|
||||||
|
|
||||||
|
template<class... Booleans>
|
||||||
|
struct cxpr_or : cxpr_or_impl<Booleans::value...> {};
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_or_c : cxpr_or_impl<Booleans...> {};
|
||||||
|
|
||||||
|
template<class... Booleans>
|
||||||
|
struct cxpr_and : cxpr_and_impl<Booleans::value...> {};
|
||||||
|
|
||||||
|
template<bool... Booleans>
|
||||||
|
struct cxpr_and_c : cxpr_and_impl<Booleans...> {};
|
||||||
|
|
||||||
|
} // namespace detail
|
||||||
|
NLOHMANN_JSON_NAMESPACE_END
|
||||||
@@ -189,37 +189,6 @@ struct actual_object_comparator
|
|||||||
template<typename BasicJsonType>
|
template<typename BasicJsonType>
|
||||||
using actual_object_comparator_t = typename actual_object_comparator<BasicJsonType>::type;
|
using actual_object_comparator_t = typename actual_object_comparator<BasicJsonType>::type;
|
||||||
|
|
||||||
template<typename T>
|
|
||||||
using detect_key_comp = decltype(std::declval<const T&>().key_comp());
|
|
||||||
|
|
||||||
// whether ObjectType can be constructed from a pair of Iterator together with
|
|
||||||
// a copy of its own comparator, the way std::map can: it needs a nested
|
|
||||||
// key_compare, a const key_comp() convertible to it, and a matching
|
|
||||||
// (Iterator, Iterator, const key_compare&) constructor.
|
|
||||||
//
|
|
||||||
// used to preserve a stateful comparator when a copy is built from a range
|
|
||||||
// past the iterative deep copy's nesting bound (see copy_object_level); an
|
|
||||||
// object type that does not satisfy this, such as nlohmann::ordered_map
|
|
||||||
// (which has key_compare for its std::map-like interface, but no key_comp()),
|
|
||||||
// keeps default-constructing its comparator, just as it always has
|
|
||||||
template<typename ObjectType, typename Iterator, typename = void>
|
|
||||||
struct is_comparator_constructible_object_type_impl : std::false_type {};
|
|
||||||
|
|
||||||
template<typename ObjectType, typename Iterator>
|
|
||||||
struct is_comparator_constructible_object_type_impl <
|
|
||||||
ObjectType, Iterator, enable_if_t<is_detected<detect_key_compare, ObjectType>::value >>
|
|
||||||
{
|
|
||||||
using key_compare = typename ObjectType::key_compare;
|
|
||||||
|
|
||||||
static constexpr bool value =
|
|
||||||
is_detected_convertible<key_compare, detect_key_comp, ObjectType>::value &&
|
|
||||||
std::is_constructible<ObjectType, Iterator, Iterator, const key_compare&>::value;
|
|
||||||
};
|
|
||||||
|
|
||||||
template<typename ObjectType, typename Iterator>
|
|
||||||
struct is_comparator_constructible_object_type
|
|
||||||
: is_comparator_constructible_object_type_impl<ObjectType, Iterator> {};
|
|
||||||
|
|
||||||
/////////////////
|
/////////////////
|
||||||
// char_traits //
|
// char_traits //
|
||||||
/////////////////
|
/////////////////
|
||||||
@@ -314,13 +283,6 @@ template<class B, class... Bn>
|
|||||||
struct conjunction<B, Bn...>
|
struct conjunction<B, Bn...>
|
||||||
: std::conditional<static_cast<bool>(B::value), conjunction<Bn...>, B>::type {};
|
: std::conditional<static_cast<bool>(B::value), conjunction<Bn...>, B>::type {};
|
||||||
|
|
||||||
// https://en.cppreference.com/w/cpp/types/disjunction
|
|
||||||
template<class...> struct disjunction : std::false_type { };
|
|
||||||
template<class B> struct disjunction<B> : B { };
|
|
||||||
template<class B, class... Bn>
|
|
||||||
struct disjunction<B, Bn...>
|
|
||||||
: std::conditional<static_cast<bool>(B::value), B, disjunction<Bn...>>::type {};
|
|
||||||
|
|
||||||
// https://en.cppreference.com/w/cpp/types/negation
|
// https://en.cppreference.com/w/cpp/types/negation
|
||||||
template<class B> struct negation : std::integral_constant < bool, !B::value > { };
|
template<class B> struct negation : std::integral_constant < bool, !B::value > { };
|
||||||
|
|
||||||
@@ -515,7 +477,9 @@ template<typename T> struct is_range_view_optional_type<std::optional<T>> : std:
|
|||||||
template<typename T> struct is_range_view_optional_type : std::false_type {};
|
template<typename T> struct is_range_view_optional_type : std::false_type {};
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if JSON_HAS_RANGE_VIEW_CONVERSION
|
// std::ranges does not work properly on MinGW due to incomplete C++20 support
|
||||||
|
// see https://github.com/nlohmann/json/issues/4916
|
||||||
|
#if JSON_HAS_RANGES && !defined(__MINGW32__)
|
||||||
|
|
||||||
// SafeToCheck guards against types that trigger circular constraints when
|
// SafeToCheck guards against types that trigger circular constraints when
|
||||||
// std::ranges::view<T> is evaluated on GCC 12 / libstdc++ 12:
|
// std::ranges::view<T> is evaluated on GCC 12 / libstdc++ 12:
|
||||||
@@ -554,7 +518,7 @@ struct is_compatible_array_type_impl <
|
|||||||
// filter_view) can match BOTH this iterator-based specialization AND the view-based one
|
// filter_view) can match BOTH this iterator-based specialization AND the view-based one
|
||||||
// below, causing ambiguity. Exclude views here so the two specializations are mutually
|
// below, causing ambiguity. Exclude views here so the two specializations are mutually
|
||||||
// exclusive: this one handles plain iterable containers, the other handles views.
|
// exclusive: this one handles plain iterable containers, the other handles views.
|
||||||
#if JSON_HAS_RANGE_VIEW_CONVERSION
|
#if JSON_HAS_RANGES && !defined(__MINGW32__)
|
||||||
&& !is_compatible_range_view<CompatibleArrayType>::value
|
&& !is_compatible_range_view<CompatibleArrayType>::value
|
||||||
#endif
|
#endif
|
||||||
>>
|
>>
|
||||||
@@ -564,7 +528,7 @@ struct is_compatible_array_type_impl <
|
|||||||
range_value_t<CompatibleArrayType>>::value;
|
range_value_t<CompatibleArrayType>>::value;
|
||||||
};
|
};
|
||||||
|
|
||||||
#if JSON_HAS_RANGE_VIEW_CONVERSION
|
#if JSON_HAS_RANGES && !defined(__MINGW32__)
|
||||||
template<typename BasicJsonType, typename CompatibleArrayType>
|
template<typename BasicJsonType, typename CompatibleArrayType>
|
||||||
struct is_compatible_array_type_impl <
|
struct is_compatible_array_type_impl <
|
||||||
BasicJsonType, CompatibleArrayType,
|
BasicJsonType, CompatibleArrayType,
|
||||||
@@ -640,6 +604,7 @@ struct is_compatible_integer_type_impl <
|
|||||||
std::is_integral<CompatibleNumberIntegerType>::value&&
|
std::is_integral<CompatibleNumberIntegerType>::value&&
|
||||||
!std::is_same<bool, CompatibleNumberIntegerType>::value >>
|
!std::is_same<bool, CompatibleNumberIntegerType>::value >>
|
||||||
{
|
{
|
||||||
|
// is there an assert somewhere on overflows?
|
||||||
using RealLimits = std::numeric_limits<RealIntegerType>;
|
using RealLimits = std::numeric_limits<RealIntegerType>;
|
||||||
using CompatibleLimits = std::numeric_limits<CompatibleNumberIntegerType>;
|
using CompatibleLimits = std::numeric_limits<CompatibleNumberIntegerType>;
|
||||||
|
|
||||||
@@ -795,30 +760,6 @@ using is_usable_as_key_type = typename std::conditional <
|
|||||||
std::true_type,
|
std::true_type,
|
||||||
std::false_type >::type;
|
std::false_type >::type;
|
||||||
|
|
||||||
#ifdef JSON_HAS_CPP_17
|
|
||||||
// type trait to check if KeyType can only be used as an object key after
|
|
||||||
// converting it to std::string_view: it is convertible to std::string_view, the
|
|
||||||
// object's comparator cannot compare it with object_t::key_type directly, but
|
|
||||||
// can compare a std::string_view. JSON pointers and JSON iterators are ruled out
|
|
||||||
// first, so that the conversion checks are never instantiated for them (a JSON
|
|
||||||
// pointer's deprecated conversion to string_t would be named otherwise).
|
|
||||||
template < typename BasicJsonType, typename KeyTypeCVRef, typename KeyType = uncvref_t<KeyTypeCVRef>,
|
|
||||||
bool = is_json_pointer<KeyType>::value || is_json_iterator_of<BasicJsonType, KeyType>::value >
|
|
||||||
struct is_string_view_convertible_key_type : std::false_type {};
|
|
||||||
|
|
||||||
template<typename BasicJsonType, typename KeyTypeCVRef, typename KeyType>
|
|
||||||
struct is_string_view_convertible_key_type<BasicJsonType, KeyTypeCVRef, KeyType, false>
|
|
||||||
: std::integral_constant < bool,
|
|
||||||
std::is_convertible<KeyTypeCVRef, std::string_view>::value
|
|
||||||
&& !is_usable_as_key_type<typename BasicJsonType::object_comparator_t,
|
|
||||||
typename BasicJsonType::object_t::key_type, KeyTypeCVRef, true, false>::value
|
|
||||||
&& is_usable_as_key_type<typename BasicJsonType::object_comparator_t,
|
|
||||||
typename BasicJsonType::object_t::key_type, std::string_view, true, false>::value > {};
|
|
||||||
#else
|
|
||||||
template<typename BasicJsonType, typename KeyTypeCVRef>
|
|
||||||
struct is_string_view_convertible_key_type : std::false_type {};
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// type trait to check if KeyType can be used as an object key
|
// type trait to check if KeyType can be used as an object key
|
||||||
// true if:
|
// true if:
|
||||||
// - KeyType is comparable with BasicJsonType::object_t::key_type
|
// - KeyType is comparable with BasicJsonType::object_t::key_type
|
||||||
@@ -832,7 +773,9 @@ using is_usable_as_basic_json_key_type = typename std::conditional <
|
|||||||
typename BasicJsonType::object_t::key_type, KeyTypeCVRef,
|
typename BasicJsonType::object_t::key_type, KeyTypeCVRef,
|
||||||
RequireTransparentComparator, ExcludeObjectKeyType>::value
|
RequireTransparentComparator, ExcludeObjectKeyType>::value
|
||||||
&& !is_json_iterator_of<BasicJsonType, KeyType>::value)
|
&& !is_json_iterator_of<BasicJsonType, KeyType>::value)
|
||||||
|| is_string_view_convertible_key_type<BasicJsonType, KeyTypeCVRef>::value
|
#ifdef JSON_HAS_CPP_17
|
||||||
|
|| std::is_convertible<KeyType, std::string_view>::value
|
||||||
|
#endif
|
||||||
, std::true_type,
|
, std::true_type,
|
||||||
std::false_type >::type;
|
std::false_type >::type;
|
||||||
|
|
||||||
@@ -867,7 +810,20 @@ struct has_capacity : std::integral_constant<bool, is_detected<detect_capacity,
|
|||||||
// a naive helper to check if a type is an ordered_map (exploits the fact that
|
// a naive helper to check if a type is an ordered_map (exploits the fact that
|
||||||
// ordered_map inherits capacity() from std::vector)
|
// ordered_map inherits capacity() from std::vector)
|
||||||
template <typename T>
|
template <typename T>
|
||||||
struct is_ordered_map : has_capacity<T> {};
|
struct is_ordered_map
|
||||||
|
{
|
||||||
|
using one = char;
|
||||||
|
|
||||||
|
struct two
|
||||||
|
{
|
||||||
|
char x[2]; // NOLINT(cppcoreguidelines-avoid-c-arrays,hicpp-avoid-c-arrays,modernize-avoid-c-arrays)
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename C> static one test( decltype(&C::capacity) ) ;
|
||||||
|
template <typename C> static two test(...);
|
||||||
|
|
||||||
|
enum { value = sizeof(test<T>(nullptr)) == sizeof(char) }; // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg,cppcoreguidelines-use-enum-class)
|
||||||
|
};
|
||||||
|
|
||||||
// to avoid useless casts (see https://github.com/nlohmann/json/issues/2893#issuecomment-889152324)
|
// to avoid useless casts (see https://github.com/nlohmann/json/issues/2893#issuecomment-889152324)
|
||||||
template < typename T, typename U, enable_if_t < !std::is_same<T, U>::value, int > = 0 >
|
template < typename T, typename U, enable_if_t < !std::is_same<T, U>::value, int > = 0 >
|
||||||
@@ -891,8 +847,10 @@ using all_signed = conjunction<std::is_signed<Types>...>;
|
|||||||
template<typename... Types>
|
template<typename... Types>
|
||||||
using all_unsigned = conjunction<std::is_unsigned<Types>...>;
|
using all_unsigned = conjunction<std::is_unsigned<Types>...>;
|
||||||
|
|
||||||
|
// there's a disjunction trait in another PR; replace when merged
|
||||||
template<typename... Types>
|
template<typename... Types>
|
||||||
using same_sign = disjunction<all_signed<Types...>, all_unsigned<Types...>>;
|
using same_sign = std::integral_constant < bool,
|
||||||
|
all_signed<Types...>::value || all_unsigned<Types...>::value >;
|
||||||
|
|
||||||
template<typename OfType, typename T>
|
template<typename OfType, typename T>
|
||||||
using never_out_of_range = std::integral_constant < bool,
|
using never_out_of_range = std::integral_constant < bool,
|
||||||
|
|||||||
@@ -26,7 +26,6 @@
|
|||||||
#include <nlohmann/detail/input/binary_reader.hpp>
|
#include <nlohmann/detail/input/binary_reader.hpp>
|
||||||
#include <nlohmann/detail/input/string_scan.hpp>
|
#include <nlohmann/detail/input/string_scan.hpp>
|
||||||
#include <nlohmann/detail/macro_scope.hpp>
|
#include <nlohmann/detail/macro_scope.hpp>
|
||||||
#include <nlohmann/detail/output/error_handler.hpp>
|
|
||||||
#include <nlohmann/detail/output/output_adapters.hpp>
|
#include <nlohmann/detail/output/output_adapters.hpp>
|
||||||
#include <nlohmann/detail/string_concat.hpp>
|
#include <nlohmann/detail/string_concat.hpp>
|
||||||
#include <nlohmann/detail/string_utils.hpp>
|
#include <nlohmann/detail/string_utils.hpp>
|
||||||
@@ -94,12 +93,8 @@ class binary_writer
|
|||||||
@param[in] sink output sink to write to (a value-type sink such as
|
@param[in] sink output sink to write to (a value-type sink such as
|
||||||
output_vector_sink, or output_adapter_sink wrapping a
|
output_vector_sink, or output_adapter_sink wrapping a
|
||||||
type-erased output adapter)
|
type-erased output adapter)
|
||||||
@param[in] error_handler_ how to treat a string value or object key that
|
|
||||||
is not valid UTF-8 (CBOR, MessagePack, UBJSON, BJData, and BSON;
|
|
||||||
never consulted by @ref write_bon8)
|
|
||||||
*/
|
*/
|
||||||
explicit binary_writer(OutputSinkType sink, const error_handler_t error_handler_ = binary_writer_default_error_handler())
|
explicit binary_writer(OutputSinkType sink) : oa(std::move(sink))
|
||||||
: oa(std::move(sink)), error_handler(error_handler_)
|
|
||||||
{}
|
{}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -112,20 +107,14 @@ class binary_writer
|
|||||||
from one.
|
from one.
|
||||||
|
|
||||||
@param[in] adapter output adapter to write to
|
@param[in] adapter output adapter to write to
|
||||||
@param[in] error_handler_ how to treat a string value or object key that
|
|
||||||
is not valid UTF-8 (CBOR, MessagePack, UBJSON, BJData, and BSON;
|
|
||||||
never consulted by @ref write_bon8)
|
|
||||||
*/
|
*/
|
||||||
template < typename SinkType = OutputSinkType,
|
template < typename SinkType = OutputSinkType,
|
||||||
typename std::enable_if < std::is_constructible<SinkType, output_adapter_t<CharType>>::value, int >::type = 0 >
|
typename std::enable_if < std::is_constructible<SinkType, output_adapter_t<CharType>>::value, int >::type = 0 >
|
||||||
explicit binary_writer(output_adapter_t<CharType> adapter, const error_handler_t error_handler_ = binary_writer_default_error_handler())
|
explicit binary_writer(output_adapter_t<CharType> adapter) : oa(SinkType(std::move(adapter)))
|
||||||
: oa(SinkType(std::move(adapter))), error_handler(error_handler_)
|
|
||||||
{}
|
{}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@param[in] j JSON value to serialize
|
@param[in] j JSON value to serialize
|
||||||
@throw type_error.316 if a string value or an object key is not valid
|
|
||||||
UTF-8
|
|
||||||
@throw type_error.317 if @a j is not an object
|
@throw type_error.317 if @a j is not an object
|
||||||
*/
|
*/
|
||||||
void write_bson(const BasicJsonType& j)
|
void write_bson(const BasicJsonType& j)
|
||||||
@@ -156,8 +145,6 @@ class binary_writer
|
|||||||
|
|
||||||
/*!
|
/*!
|
||||||
@param[in] j JSON value to serialize
|
@param[in] j JSON value to serialize
|
||||||
@throw type_error.316 if a string value or an object key is not valid
|
|
||||||
UTF-8
|
|
||||||
*/
|
*/
|
||||||
void write_cbor(const BasicJsonType& j)
|
void write_cbor(const BasicJsonType& j)
|
||||||
{
|
{
|
||||||
@@ -224,16 +211,13 @@ class binary_writer
|
|||||||
|
|
||||||
case value_t::string:
|
case value_t::string:
|
||||||
{
|
{
|
||||||
string_t storage;
|
|
||||||
const string_t& value = sanitize_utf8_for_write(*j.m_data.m_value.string, j, storage);
|
|
||||||
|
|
||||||
// step 1: write control byte and the string length
|
// step 1: write control byte and the string length
|
||||||
write_cbor_head(0x60, value.size());
|
write_cbor_head(0x60, j.m_data.m_value.string->size());
|
||||||
|
|
||||||
// step 2: write the string
|
// step 2: write the string
|
||||||
oa.write_characters(
|
oa.write_characters(
|
||||||
reinterpret_cast<const CharType*>(value.data()),
|
reinterpret_cast<const CharType*>(j.m_data.m_value.string->data()),
|
||||||
value.size());
|
j.m_data.m_value.string->size());
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -303,17 +287,6 @@ class binary_writer
|
|||||||
// step 2: write each element
|
// step 2: write each element
|
||||||
for (const auto& el : *j.m_data.m_value.object)
|
for (const auto& el : *j.m_data.m_value.object)
|
||||||
{
|
{
|
||||||
// el.first is checked here, against the object as
|
|
||||||
// diagnostics context, because write_cbor(el.first)
|
|
||||||
// converts it to a temporary basic_json that would be
|
|
||||||
// used as the context instead; for error_handler_t::keep
|
|
||||||
// and ::replace/::ignore the recursive write_cbor(el.first)
|
|
||||||
// call below handles the key like any other string, so no
|
|
||||||
// separate check is needed here for those
|
|
||||||
if (error_handler == error_handler_t::strict)
|
|
||||||
{
|
|
||||||
check_utf8(el.first, j);
|
|
||||||
}
|
|
||||||
write_cbor(el.first);
|
write_cbor(el.first);
|
||||||
write_cbor(el.second);
|
write_cbor(el.second);
|
||||||
}
|
}
|
||||||
@@ -461,11 +434,8 @@ class binary_writer
|
|||||||
|
|
||||||
case value_t::string:
|
case value_t::string:
|
||||||
{
|
{
|
||||||
string_t storage;
|
|
||||||
const string_t& value = sanitize_utf8_for_write(*j.m_data.m_value.string, j, storage);
|
|
||||||
|
|
||||||
// step 1: write control byte and the string length
|
// step 1: write control byte and the string length
|
||||||
const auto N = to_msgpack_length(value.size(), j);
|
const auto N = to_msgpack_length(j.m_data.m_value.string->size(), j);
|
||||||
if (N <= 31)
|
if (N <= 31)
|
||||||
{
|
{
|
||||||
// fixstr
|
// fixstr
|
||||||
@@ -492,8 +462,8 @@ class binary_writer
|
|||||||
|
|
||||||
// step 2: write the string
|
// step 2: write the string
|
||||||
oa.write_characters(
|
oa.write_characters(
|
||||||
reinterpret_cast<const CharType*>(value.data()),
|
reinterpret_cast<const CharType*>(j.m_data.m_value.string->data()),
|
||||||
value.size());
|
j.m_data.m_value.string->size());
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -640,13 +610,6 @@ class binary_writer
|
|||||||
// step 2: write each element
|
// step 2: write each element
|
||||||
for (const auto& el : *j.m_data.m_value.object)
|
for (const auto& el : *j.m_data.m_value.object)
|
||||||
{
|
{
|
||||||
// as in write_cbor, el.first is checked here against the
|
|
||||||
// object as diagnostics context; the recursive call below
|
|
||||||
// handles keep/replace/ignore like any other string
|
|
||||||
if (error_handler == error_handler_t::strict)
|
|
||||||
{
|
|
||||||
check_utf8(el.first, j);
|
|
||||||
}
|
|
||||||
write_msgpack(el.first);
|
write_msgpack(el.first);
|
||||||
write_msgpack(el.second);
|
write_msgpack(el.second);
|
||||||
}
|
}
|
||||||
@@ -666,8 +629,6 @@ class binary_writer
|
|||||||
@param[in] add_prefix whether prefixes need to be used for this value
|
@param[in] add_prefix whether prefixes need to be used for this value
|
||||||
@param[in] use_bjdata whether write in BJData format, default is false
|
@param[in] use_bjdata whether write in BJData format, default is false
|
||||||
@param[in] bjdata_version which BJData version to use, default is draft2
|
@param[in] bjdata_version which BJData version to use, default is draft2
|
||||||
@throw type_error.316 if a string value or an object key is not valid
|
|
||||||
UTF-8
|
|
||||||
*/
|
*/
|
||||||
void write_ubjson(const BasicJsonType& j, const bool use_count,
|
void write_ubjson(const BasicJsonType& j, const bool use_count,
|
||||||
const bool use_type, const bool add_prefix = true,
|
const bool use_type, const bool add_prefix = true,
|
||||||
@@ -717,17 +678,14 @@ class binary_writer
|
|||||||
|
|
||||||
case value_t::string:
|
case value_t::string:
|
||||||
{
|
{
|
||||||
string_t storage;
|
|
||||||
const string_t& value = sanitize_utf8_for_write(*j.m_data.m_value.string, j, storage);
|
|
||||||
|
|
||||||
if (add_prefix)
|
if (add_prefix)
|
||||||
{
|
{
|
||||||
oa.write_character(to_char_type('S'));
|
oa.write_character(to_char_type('S'));
|
||||||
}
|
}
|
||||||
write_number_with_ubjson_prefix(value.size(), true, use_bjdata);
|
write_number_with_ubjson_prefix(j.m_data.m_value.string->size(), true, use_bjdata);
|
||||||
oa.write_characters(
|
oa.write_characters(
|
||||||
reinterpret_cast<const CharType*>(value.data()),
|
reinterpret_cast<const CharType*>(j.m_data.m_value.string->data()),
|
||||||
value.size());
|
j.m_data.m_value.string->size());
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -882,12 +840,10 @@ class binary_writer
|
|||||||
|
|
||||||
for (const auto& el : *j.m_data.m_value.object)
|
for (const auto& el : *j.m_data.m_value.object)
|
||||||
{
|
{
|
||||||
string_t storage;
|
write_number_with_ubjson_prefix(el.first.size(), true, use_bjdata);
|
||||||
const string_t& key = sanitize_utf8_for_write(el.first, j, storage);
|
|
||||||
write_number_with_ubjson_prefix(key.size(), true, use_bjdata);
|
|
||||||
oa.write_characters(
|
oa.write_characters(
|
||||||
reinterpret_cast<const CharType*>(key.data()),
|
reinterpret_cast<const CharType*>(el.first.data()),
|
||||||
key.size());
|
el.first.size());
|
||||||
write_ubjson(el.second, use_count, use_type, prefix_required, use_bjdata, bjdata_version);
|
write_ubjson(el.second, use_count, use_type, prefix_required, use_bjdata, bjdata_version);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -928,12 +884,8 @@ class binary_writer
|
|||||||
/*!
|
/*!
|
||||||
@return The size of a BSON document entry header, including the id marker
|
@return The size of a BSON document entry header, including the id marker
|
||||||
and the entry name size (and its null-terminator).
|
and the entry name size (and its null-terminator).
|
||||||
@throw out_of_range.409 if @a name contains U+0000, before anything is
|
|
||||||
written
|
|
||||||
@throw type_error.316 if @a name is not valid UTF-8, before anything is
|
|
||||||
written
|
|
||||||
*/
|
*/
|
||||||
std::size_t calc_bson_entry_header_size(const string_t& name, const BasicJsonType& j)
|
static std::size_t calc_bson_entry_header_size(const string_t& name, const BasicJsonType& j)
|
||||||
{
|
{
|
||||||
const auto it = name.find(static_cast<typename string_t::value_type>(0));
|
const auto it = name.find(static_cast<typename string_t::value_type>(0));
|
||||||
if (JSON_HEDLEY_UNLIKELY(it != BasicJsonType::string_t::npos))
|
if (JSON_HEDLEY_UNLIKELY(it != BasicJsonType::string_t::npos))
|
||||||
@@ -941,10 +893,8 @@ class binary_writer
|
|||||||
JSON_THROW(out_of_range::create(409, concat("BSON key cannot contain code point U+0000 (at byte ", std::to_string(it), ")"), &j));
|
JSON_THROW(out_of_range::create(409, concat("BSON key cannot contain code point U+0000 (at byte ", std::to_string(it), ")"), &j));
|
||||||
}
|
}
|
||||||
|
|
||||||
string_t storage;
|
static_cast<void>(j);
|
||||||
const string_t& sanitized = sanitize_utf8_for_write(name, j, storage);
|
return /*id*/ 1ul + name.size() + /*zero-terminator*/1u;
|
||||||
|
|
||||||
return /*id*/ 1ul + sanitized.size() + /*zero-terminator*/1u;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -964,28 +914,14 @@ class binary_writer
|
|||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief Writes the given @a element_type and @a name to the output adapter
|
@brief Writes the given @a element_type and @a name to the output adapter
|
||||||
|
|
||||||
@a name has already been validated (and, for @ref error_handler_t::strict,
|
|
||||||
found well-formed) by @ref calc_bson_entry_header_size during the earlier
|
|
||||||
size pass, so only @ref error_handler_t::replace / @ref
|
|
||||||
error_handler_t::ignore need to sanitize it again here, to actually write
|
|
||||||
the bytes that size was computed from.
|
|
||||||
*/
|
*/
|
||||||
void write_bson_entry_header(const string_t& name,
|
void write_bson_entry_header(const string_t& name,
|
||||||
const std::uint8_t element_type)
|
const std::uint8_t element_type)
|
||||||
{
|
{
|
||||||
oa.write_character(to_char_type(element_type));
|
oa.write_character(to_char_type(element_type));
|
||||||
|
oa.write_characters(
|
||||||
if (error_handler == error_handler_t::keep || error_handler == error_handler_t::strict || is_valid_utf8(name))
|
reinterpret_cast<const CharType*>(name.data()),
|
||||||
{
|
name.size());
|
||||||
oa.write_characters(reinterpret_cast<const CharType*>(name.data()), name.size());
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
const string_t sanitized = sanitize_utf8(name, error_handler);
|
|
||||||
oa.write_characters(reinterpret_cast<const CharType*>(sanitized.data()), sanitized.size());
|
|
||||||
}
|
|
||||||
|
|
||||||
// the terminating null byte is written explicitly rather than taken
|
// the terminating null byte is written explicitly rather than taken
|
||||||
// from the buffer, so that string_t::data() need not be null-terminated
|
// from the buffer, so that string_t::data() need not be null-terminated
|
||||||
oa.write_character(to_char_type(0x00));
|
oa.write_character(to_char_type(0x00));
|
||||||
@@ -1013,50 +949,24 @@ class binary_writer
|
|||||||
|
|
||||||
/*!
|
/*!
|
||||||
@return The size of the BSON-encoded string in @a value
|
@return The size of the BSON-encoded string in @a value
|
||||||
@throw type_error.316 if @a value is not valid UTF-8, before anything is
|
|
||||||
written
|
|
||||||
|
|
||||||
@note The UTF-8 check is skipped if @a value is already too long for the
|
|
||||||
32-bit BSON length field (@ref to_bson_length rejects it later, once
|
|
||||||
the size of the whole document is known); this also keeps the check
|
|
||||||
from reading past a StringType that reports a size larger than what
|
|
||||||
it actually holds.
|
|
||||||
*/
|
*/
|
||||||
std::size_t calc_bson_string_size(const string_t& value, const BasicJsonType& j)
|
static std::size_t calc_bson_string_size(const string_t& value)
|
||||||
{
|
{
|
||||||
if (JSON_HEDLEY_LIKELY(value_in_range_of<std::int32_t>(value.size())))
|
|
||||||
{
|
|
||||||
string_t storage;
|
|
||||||
const string_t& sanitized = sanitize_utf8_for_write(value, j, storage);
|
|
||||||
return sizeof(std::int32_t) + sanitized.size() + 1ul;
|
|
||||||
}
|
|
||||||
return sizeof(std::int32_t) + value.size() + 1ul;
|
return sizeof(std::int32_t) + value.size() + 1ul;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief Writes a BSON element with key @a name and string value @a value
|
@brief Writes a BSON element with key @a name and string value @a value
|
||||||
|
|
||||||
@a value has already been validated (and, for @ref error_handler_t::strict,
|
|
||||||
found well-formed) by @ref calc_bson_string_size during the earlier size
|
|
||||||
pass, so only @ref error_handler_t::replace / @ref error_handler_t::ignore
|
|
||||||
need to sanitize it again here, to actually write the bytes that size was
|
|
||||||
computed from.
|
|
||||||
*/
|
*/
|
||||||
void write_bson_string(const string_t& name,
|
void write_bson_string(const string_t& name,
|
||||||
const string_t& value)
|
const string_t& value)
|
||||||
{
|
{
|
||||||
write_bson_entry_header(name, 0x02);
|
write_bson_entry_header(name, 0x02);
|
||||||
|
|
||||||
const bool sanitize = error_handler != error_handler_t::keep
|
write_number<std::int32_t>(to_bson_length(value.size() + 1ul), true);
|
||||||
&& error_handler != error_handler_t::strict
|
|
||||||
&& !is_valid_utf8(value);
|
|
||||||
const string_t sanitized = sanitize ? sanitize_utf8(value, error_handler) : string_t{};
|
|
||||||
const string_t& written = sanitize ? sanitized : value;
|
|
||||||
|
|
||||||
write_number<std::int32_t>(to_bson_length(written.size() + 1ul), true);
|
|
||||||
oa.write_characters(
|
oa.write_characters(
|
||||||
reinterpret_cast<const CharType*>(written.data()),
|
reinterpret_cast<const CharType*>(value.data()),
|
||||||
written.size());
|
value.size());
|
||||||
// the terminating null byte is written explicitly rather than taken
|
// the terminating null byte is written explicitly rather than taken
|
||||||
// from the buffer, so that string_t::data() need not be null-terminated
|
// from the buffer, so that string_t::data() need not be null-terminated
|
||||||
oa.write_character(to_char_type(0x00));
|
oa.write_character(to_char_type(0x00));
|
||||||
@@ -1170,10 +1080,8 @@ class binary_writer
|
|||||||
is neither an object nor an array
|
is neither an object nor an array
|
||||||
@throw out_of_range.415 if @a j is binary with a subtype that does not fit
|
@throw out_of_range.415 if @a j is binary with a subtype that does not fit
|
||||||
into a byte, before anything is written
|
into a byte, before anything is written
|
||||||
@throw type_error.316 if @a j is a string that is not valid UTF-8, before
|
|
||||||
anything is written
|
|
||||||
*/
|
*/
|
||||||
std::size_t calc_bson_value_size(const BasicJsonType& j)
|
static std::size_t calc_bson_value_size(const BasicJsonType& j)
|
||||||
{
|
{
|
||||||
switch (j.type())
|
switch (j.type())
|
||||||
{
|
{
|
||||||
@@ -1193,7 +1101,7 @@ class binary_writer
|
|||||||
return calc_bson_unsigned_size(j.m_data.m_value.number_unsigned);
|
return calc_bson_unsigned_size(j.m_data.m_value.number_unsigned);
|
||||||
|
|
||||||
case value_t::string:
|
case value_t::string:
|
||||||
return calc_bson_string_size(*j.m_data.m_value.string, j);
|
return calc_bson_string_size(*j.m_data.m_value.string);
|
||||||
|
|
||||||
case value_t::null:
|
case value_t::null:
|
||||||
return 0ul;
|
return 0ul;
|
||||||
@@ -1306,10 +1214,8 @@ class binary_writer
|
|||||||
written
|
written
|
||||||
@throw out_of_range.415 if a binary value's subtype does not fit into a
|
@throw out_of_range.415 if a binary value's subtype does not fit into a
|
||||||
byte, before anything is written
|
byte, before anything is written
|
||||||
@throw type_error.316 if a string value or a key is not valid UTF-8,
|
|
||||||
before anything is written
|
|
||||||
*/
|
*/
|
||||||
std::size_t calc_bson_sizes(const BasicJsonType& document, std::vector<std::size_t>& nested_sizes)
|
static std::size_t calc_bson_sizes(const BasicJsonType& document, std::vector<std::size_t>& nested_sizes)
|
||||||
{
|
{
|
||||||
// the object or array whose entries are being sized, and the ones it
|
// the object or array whose entries are being sized, and the ones it
|
||||||
// is in; nothing is allocated unless the document nests
|
// is in; nothing is allocated unless the document nests
|
||||||
@@ -2186,7 +2092,7 @@ class binary_writer
|
|||||||
*/
|
*/
|
||||||
void write_bon8_string(const string_t& s, bool& string_open, const BasicJsonType& context)
|
void write_bon8_string(const string_t& s, bool& string_open, const BasicJsonType& context)
|
||||||
{
|
{
|
||||||
check_utf8(s, context);
|
check_bon8_utf8(s, context);
|
||||||
|
|
||||||
// a string that follows another string terminates it
|
// a string that follows another string terminates it
|
||||||
if (string_open)
|
if (string_open)
|
||||||
@@ -2216,7 +2122,7 @@ class binary_writer
|
|||||||
@throw type_error.316 if @a s is not valid UTF-8; the message names the
|
@throw type_error.316 if @a s is not valid UTF-8; the message names the
|
||||||
first byte of the first invalid or incomplete sequence
|
first byte of the first invalid or incomplete sequence
|
||||||
*/
|
*/
|
||||||
static void check_utf8(const string_t& s, const BasicJsonType& context)
|
static void check_bon8_utf8(const string_t& s, const BasicJsonType& context)
|
||||||
{
|
{
|
||||||
static_cast<void>(context); // only used when exceptions are enabled
|
static_cast<void>(context); // only used when exceptions are enabled
|
||||||
const auto* data = reinterpret_cast<const unsigned char*>(s.data());
|
const auto* data = reinterpret_cast<const unsigned char*>(s.data());
|
||||||
@@ -2227,57 +2133,6 @@ class binary_writer
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief return @a s as it should be written, honoring @ref error_handler
|
|
||||||
|
|
||||||
Used by @ref write_cbor, @ref write_msgpack, @ref write_ubjson (and so
|
|
||||||
@ref write_bjdata), and the BSON writing functions for string values and
|
|
||||||
object keys; never by @ref write_bon8, which always validates, since UTF-8
|
|
||||||
lead bytes are structural there.
|
|
||||||
|
|
||||||
- @ref error_handler_t::keep: @a s is returned unchanged, without even
|
|
||||||
checking it (the behavior of release 3.12.0 and earlier).
|
|
||||||
- @ref error_handler_t::strict: @ref check_utf8 is called, which throws
|
|
||||||
type_error.316 if @a s is not valid UTF-8.
|
|
||||||
- @ref error_handler_t::replace / @ref error_handler_t::ignore: @a s is
|
|
||||||
sanitized into @a storage with exactly the rules @ref
|
|
||||||
serializer::dump_escaped_impl uses, so that parsing what @ref
|
|
||||||
basic_json::dump produces for the same string and the same handler
|
|
||||||
yields the same result.
|
|
||||||
|
|
||||||
Well-formed input is never copied: this returns a reference to @a s
|
|
||||||
itself in every case but a sanitized `replace`/`ignore` one, so @a
|
|
||||||
storage must outlive the returned reference only then.
|
|
||||||
|
|
||||||
@param[in] s the string (value or object key) to write
|
|
||||||
@param[in] context the value @a s belongs to (for diagnostics)
|
|
||||||
@param[out] storage backing storage for a sanitized copy
|
|
||||||
|
|
||||||
@return a reference to @a s, or to @a storage once it holds a sanitized copy
|
|
||||||
*/
|
|
||||||
const string_t& sanitize_utf8_for_write(const string_t& s, const BasicJsonType& context, string_t& storage) const
|
|
||||||
{
|
|
||||||
switch (error_handler)
|
|
||||||
{
|
|
||||||
case error_handler_t::keep:
|
|
||||||
return s; // NOLINT(bugprone-return-const-ref-from-parameter): callers pass lvalues that outlive the call
|
|
||||||
|
|
||||||
case error_handler_t::strict:
|
|
||||||
check_utf8(s, context);
|
|
||||||
return s; // NOLINT(bugprone-return-const-ref-from-parameter): callers pass lvalues that outlive the call
|
|
||||||
|
|
||||||
case error_handler_t::replace:
|
|
||||||
case error_handler_t::ignore:
|
|
||||||
default:
|
|
||||||
if (is_valid_utf8(s))
|
|
||||||
{
|
|
||||||
return s; // NOLINT(bugprone-return-const-ref-from-parameter): callers pass lvalues that outlive the call
|
|
||||||
}
|
|
||||||
storage = sanitize_utf8(s, error_handler);
|
|
||||||
return storage;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief write an integer in the shortest encoding
|
@brief write an integer in the shortest encoding
|
||||||
|
|
||||||
@@ -2606,10 +2461,6 @@ class binary_writer
|
|||||||
|
|
||||||
/// the output
|
/// the output
|
||||||
OutputSinkType oa;
|
OutputSinkType oa;
|
||||||
|
|
||||||
/// how to treat a string value or object key that is not valid UTF-8
|
|
||||||
/// (CBOR, MessagePack, UBJSON, BJData, and BSON; not BON8)
|
|
||||||
const error_handler_t error_handler = binary_writer_default_error_handler();
|
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace detail
|
} // namespace detail
|
||||||
|
|||||||
@@ -1,50 +0,0 @@
|
|||||||
// __ _____ _____ _____
|
|
||||||
// __| | __| | | | JSON for Modern C++
|
|
||||||
// | | |__ | | | | | | version 3.12.0
|
|
||||||
// |_____|_____|_____|_|___| https://github.com/nlohmann/json
|
|
||||||
//
|
|
||||||
// SPDX-FileCopyrightText: 2013-2026 Niels Lohmann <https://nlohmann.me>
|
|
||||||
// SPDX-License-Identifier: MIT
|
|
||||||
|
|
||||||
#pragma once
|
|
||||||
|
|
||||||
#include <nlohmann/detail/abi_macros.hpp>
|
|
||||||
|
|
||||||
NLOHMANN_JSON_NAMESPACE_BEGIN
|
|
||||||
namespace detail
|
|
||||||
{
|
|
||||||
|
|
||||||
/// how to treat decoding errors
|
|
||||||
///
|
|
||||||
/// @ref basic_json::dump uses this to decide what to do with ill-formed
|
|
||||||
/// UTF-8 while escaping a string, and the binary writers (@ref
|
|
||||||
/// basic_json::to_cbor, @ref basic_json::to_ubjson, @ref
|
|
||||||
/// basic_json::to_bjdata, @ref basic_json::to_bson) use it the same way for
|
|
||||||
/// string values and object keys. The binary readers (@ref
|
|
||||||
/// basic_json::from_cbor, @ref basic_json::from_msgpack, @ref
|
|
||||||
/// basic_json::from_ubjson, @ref basic_json::from_bjdata, @ref
|
|
||||||
/// basic_json::from_bson) use it to decide whether to check text strings
|
|
||||||
/// and object keys for well-formed UTF-8 at all, since none of those
|
|
||||||
/// formats requires a decoder to do so.
|
|
||||||
enum class error_handler_t
|
|
||||||
{
|
|
||||||
strict, ///< throw a type_error/parse_error exception in case of invalid UTF-8
|
|
||||||
replace, ///< replace invalid UTF-8 sequences with U+FFFD
|
|
||||||
ignore, ///< ignore invalid UTF-8 sequences
|
|
||||||
keep ///< keep invalid UTF-8 sequences unchanged
|
|
||||||
};
|
|
||||||
|
|
||||||
/// the default error handler of the CBOR, UBJSON, BJData, and BSON writers:
|
|
||||||
/// error_handler_t::strict if JSON_STRICT_BINARY_UTF8 is enabled, otherwise
|
|
||||||
/// error_handler_t::keep (the behavior before version 3.13.0)
|
|
||||||
constexpr error_handler_t binary_writer_default_error_handler() noexcept
|
|
||||||
{
|
|
||||||
#if JSON_STRICT_BINARY_UTF8
|
|
||||||
return error_handler_t::strict;
|
|
||||||
#else
|
|
||||||
return error_handler_t::keep;
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace detail
|
|
||||||
NLOHMANN_JSON_NAMESPACE_END
|
|
||||||
@@ -27,7 +27,6 @@
|
|||||||
#include <nlohmann/detail/input/string_scan.hpp>
|
#include <nlohmann/detail/input/string_scan.hpp>
|
||||||
#include <nlohmann/detail/macro_scope.hpp>
|
#include <nlohmann/detail/macro_scope.hpp>
|
||||||
#include <nlohmann/detail/meta/cpp_future.hpp>
|
#include <nlohmann/detail/meta/cpp_future.hpp>
|
||||||
#include <nlohmann/detail/output/error_handler.hpp>
|
|
||||||
#include <nlohmann/detail/output/output_adapters.hpp>
|
#include <nlohmann/detail/output/output_adapters.hpp>
|
||||||
#include <nlohmann/detail/recursion_depth_limit.hpp>
|
#include <nlohmann/detail/recursion_depth_limit.hpp>
|
||||||
#include <nlohmann/detail/string_concat.hpp>
|
#include <nlohmann/detail/string_concat.hpp>
|
||||||
@@ -42,6 +41,14 @@ namespace detail
|
|||||||
// serialization //
|
// serialization //
|
||||||
///////////////////
|
///////////////////
|
||||||
|
|
||||||
|
/// how to treat decoding errors
|
||||||
|
enum class error_handler_t
|
||||||
|
{
|
||||||
|
strict, ///< throw a type_error exception in case of invalid UTF-8
|
||||||
|
replace, ///< replace invalid UTF-8 sequences with U+FFFD
|
||||||
|
ignore ///< ignore invalid UTF-8 sequences
|
||||||
|
};
|
||||||
|
|
||||||
template<typename BasicJsonType>
|
template<typename BasicJsonType>
|
||||||
class serializer
|
class serializer
|
||||||
{
|
{
|
||||||
@@ -706,11 +713,6 @@ class serializer
|
|||||||
@a ensure_ascii is a template parameter here so that the branch on it is
|
@a ensure_ascii is a template parameter here so that the branch on it is
|
||||||
resolved once, outside the loop; see @ref dump_escaped.
|
resolved once, outside the loop; see @ref dump_escaped.
|
||||||
*/
|
*/
|
||||||
#ifdef JSON_HEDLEY_MSVC_VERSION
|
|
||||||
#pragma warning(push)
|
|
||||||
// EnsureAscii is a template parameter; C++11 has no if constexpr
|
|
||||||
#pragma warning(disable : 4127) // conditional expression is constant
|
|
||||||
#endif
|
|
||||||
template<bool EnsureAscii>
|
template<bool EnsureAscii>
|
||||||
void dump_escaped_impl(const string_t& s)
|
void dump_escaped_impl(const string_t& s)
|
||||||
{
|
{
|
||||||
@@ -837,16 +839,6 @@ class serializer
|
|||||||
// EnsureAscii parameter is used, non-ASCII characters
|
// EnsureAscii parameter is used, non-ASCII characters
|
||||||
if ((codepoint <= 0x1F) || (EnsureAscii && (codepoint >= 0x7F)))
|
if ((codepoint <= 0x1F) || (EnsureAscii && (codepoint >= 0x7F)))
|
||||||
{
|
{
|
||||||
if (EnsureAscii && error_handler == error_handler_t::keep)
|
|
||||||
{
|
|
||||||
// this character was buffered as raw bytes
|
|
||||||
// below in case it turned out to be part of
|
|
||||||
// an ill-formed sequence (which is kept as
|
|
||||||
// is); now that it decoded to a well-formed
|
|
||||||
// code point, undo that and \u-escape it
|
|
||||||
// like any other character instead
|
|
||||||
bytes = bytes_after_last_accept;
|
|
||||||
}
|
|
||||||
if (codepoint <= 0xFFFF)
|
if (codepoint <= 0xFFFF)
|
||||||
{
|
{
|
||||||
write_u_escape(bytes, static_cast<std::uint16_t>(codepoint));
|
write_u_escape(bytes, static_cast<std::uint16_t>(codepoint));
|
||||||
@@ -945,44 +937,6 @@ class serializer
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
case error_handler_t::keep:
|
|
||||||
{
|
|
||||||
// the bytes of this (now abandoned) ill-formed
|
|
||||||
// sequence seen so far are already buffered below
|
|
||||||
// and are kept unchanged in the output
|
|
||||||
if (undumped_chars > 0)
|
|
||||||
{
|
|
||||||
// the byte that ended the sequence may be OK
|
|
||||||
// for itself (e.g., a quote that must still be
|
|
||||||
// escaped, or the lead byte of a well-formed
|
|
||||||
// code point), so read it again
|
|
||||||
--i;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
// a byte that cannot start a sequence (e.g.,
|
|
||||||
// 0xFF or a stray continuation byte) is kept
|
|
||||||
// as well
|
|
||||||
string_buffer[bytes++] = s[i];
|
|
||||||
}
|
|
||||||
|
|
||||||
// write buffer and reset index; there must be 13 bytes
|
|
||||||
// left, as this is the maximal number of bytes to be
|
|
||||||
// written ("\uxxxx\uxxxx\0") for one code point
|
|
||||||
if (string_buffer.size() - bytes < 13)
|
|
||||||
{
|
|
||||||
put_buffer(string_buffer, bytes);
|
|
||||||
bytes = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
bytes_after_last_accept = bytes;
|
|
||||||
undumped_chars = 0;
|
|
||||||
|
|
||||||
// continue processing the string
|
|
||||||
state = UTF8_ACCEPT;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
default: // LCOV_EXCL_LINE
|
default: // LCOV_EXCL_LINE
|
||||||
JSON_ASSERT(false); // NOLINT(cert-dcl03-c,hicpp-static-assert,misc-static-assert) LCOV_EXCL_LINE
|
JSON_ASSERT(false); // NOLINT(cert-dcl03-c,hicpp-static-assert,misc-static-assert) LCOV_EXCL_LINE
|
||||||
}
|
}
|
||||||
@@ -991,12 +945,9 @@ class serializer
|
|||||||
|
|
||||||
default: // decode found yet incomplete multibyte code point
|
default: // decode found yet incomplete multibyte code point
|
||||||
{
|
{
|
||||||
if (!EnsureAscii || error_handler == error_handler_t::keep)
|
if (!EnsureAscii)
|
||||||
{
|
{
|
||||||
// code point will not be escaped (or will be kept as
|
// code point will not be escaped - copy byte to buffer
|
||||||
// is if it turns out to be ill-formed) - copy byte to
|
|
||||||
// buffer; dropped again above if it decodes to a
|
|
||||||
// well-formed code point that needs \u-escaping
|
|
||||||
string_buffer[bytes++] = s[i];
|
string_buffer[bytes++] = s[i];
|
||||||
}
|
}
|
||||||
++undumped_chars;
|
++undumped_chars;
|
||||||
@@ -1047,22 +998,11 @@ class serializer
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
case error_handler_t::keep:
|
|
||||||
{
|
|
||||||
// write the ill-formed trailing bytes as is; they were
|
|
||||||
// buffered above regardless of EnsureAscii
|
|
||||||
put_buffer(string_buffer, bytes);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
default: // LCOV_EXCL_LINE
|
default: // LCOV_EXCL_LINE
|
||||||
JSON_ASSERT(false); // NOLINT(cert-dcl03-c,hicpp-static-assert,misc-static-assert) LCOV_EXCL_LINE
|
JSON_ASSERT(false); // NOLINT(cert-dcl03-c,hicpp-static-assert,misc-static-assert) LCOV_EXCL_LINE
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
#ifdef JSON_HEDLEY_MSVC_VERSION
|
|
||||||
#pragma warning(pop)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
private:
|
private:
|
||||||
/*!
|
/*!
|
||||||
|
|||||||
@@ -39,6 +39,7 @@ inline std::size_t concat_length(const char /*c*/, const Args& ... rest)
|
|||||||
template<typename... Args>
|
template<typename... Args>
|
||||||
inline std::size_t concat_length(const char* cstr, const Args& ... rest)
|
inline std::size_t concat_length(const char* cstr, const Args& ... rest)
|
||||||
{
|
{
|
||||||
|
// cppcheck-suppress ignoredReturnValue
|
||||||
return ::strlen(cstr) + concat_length(rest...);
|
return ::strlen(cstr) + concat_length(rest...);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,6 @@
|
|||||||
|
|
||||||
#include <nlohmann/detail/abi_macros.hpp>
|
#include <nlohmann/detail/abi_macros.hpp>
|
||||||
#include <nlohmann/detail/macro_scope.hpp>
|
#include <nlohmann/detail/macro_scope.hpp>
|
||||||
#include <nlohmann/detail/output/error_handler.hpp>
|
|
||||||
|
|
||||||
NLOHMANN_JSON_NAMESPACE_BEGIN
|
NLOHMANN_JSON_NAMESPACE_BEGIN
|
||||||
namespace detail
|
namespace detail
|
||||||
@@ -118,14 +117,13 @@ This is a single-byte step of a "shift-based" UTF-8 decoder originally
|
|||||||
written by Björn Hoehrmann. See
|
written by Björn Hoehrmann. See
|
||||||
http://bjoern.hoehrmann.de/utf-8/decoder/dfa/ for details.
|
http://bjoern.hoehrmann.de/utf-8/decoder/dfa/ for details.
|
||||||
|
|
||||||
The library checks UTF-8 well-formedness (RFC 3629, section 4) in three
|
The library checks UTF-8 well-formedness (RFC 3629, section 4) in four
|
||||||
places, which differ in speed, diagnostics, and how they read the input:
|
places, which differ in speed, diagnostics, and how they read the input:
|
||||||
|
|
||||||
- decode() below: the serializer, to escape and, in strict mode, reject
|
- decode() and @ref is_valid_utf8 below: the serializer (to escape and, in
|
||||||
ill-formed UTF-8 when dumping a string. The CBOR, MessagePack, BSON,
|
strict mode, reject ill-formed UTF-8 when dumping a string) and the CBOR,
|
||||||
UBJSON and BJData readers do not use it: none of those specs requires a
|
MessagePack, BSON, UBJSON and BJData readers (to reject ill-formed UTF-8 in
|
||||||
decoder to reject ill-formed UTF-8 in text strings, so the readers keep
|
text strings at decode time).
|
||||||
the bytes as is and leave the check to dump() and the binary writers.
|
|
||||||
- the per-lead-byte switch in lexer::scan_string(): JSON text, with a
|
- the per-lead-byte switch in lexer::scan_string(): JSON text, with a
|
||||||
diagnostic for each kind of error.
|
diagnostic for each kind of error.
|
||||||
- validate_one_utf8() and valid_utf8_prefix() in string_scan.hpp: the lexer's
|
- validate_one_utf8() and valid_utf8_prefix() in string_scan.hpp: the lexer's
|
||||||
@@ -181,19 +179,19 @@ inline std::uint8_t decode(std::uint8_t& state, std::uint32_t& codep, const std:
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@brief check a string for well-formed UTF-8 (RFC 3629, section 4)
|
@brief check whether a string consists solely of valid UTF-8
|
||||||
|
|
||||||
Used by the binary readers (CBOR, MessagePack, UBJSON, BJData, BSON) when an
|
Used by the CBOR/MessagePack/BSON/UBJSON binary readers to reject text
|
||||||
@ref error_handler_t other than `keep` is requested for a text string value
|
strings that are not valid UTF-8 at decode time (RFC 8949 §3.1 and the
|
||||||
or object key: none of those formats requires a decoder to reject ill-formed
|
MessagePack/BSON specifications all require text strings to be UTF-8), so
|
||||||
UTF-8 on its own, so the check is opt-in there, unlike the JSON lexer and the
|
that malformed input is caught immediately instead of only surfacing later
|
||||||
serializer's @ref decode -based escaping, which always run it.
|
as a type_error.316 when the resulting value is dumped.
|
||||||
|
|
||||||
@param[in] s the string to check
|
@param[in] s the string to check
|
||||||
@param[in] first the index to start checking at
|
@param[in] first index of the first byte to check; the bytes before it are
|
||||||
@return whether `s.substr(first)` is well-formed UTF-8
|
assumed to have been validated already and to end on a
|
||||||
|
code point boundary
|
||||||
@sa @ref decode
|
@return whether @a s (from index @a first on) is valid UTF-8
|
||||||
*/
|
*/
|
||||||
template<typename StringType>
|
template<typename StringType>
|
||||||
inline bool is_valid_utf8(const StringType& s, const std::size_t first = 0) noexcept
|
inline bool is_valid_utf8(const StringType& s, const std::size_t first = 0) noexcept
|
||||||
@@ -213,101 +211,5 @@ inline bool is_valid_utf8(const StringType& s, const std::size_t first = 0) noex
|
|||||||
return state == UTF8_ACCEPT;
|
return state == UTF8_ACCEPT;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
|
||||||
@brief sanitize a string with ill-formed UTF-8 for @ref error_handler_t::replace or @ref error_handler_t::ignore
|
|
||||||
|
|
||||||
Replaces every maximal ill-formed subsequence with U+FFFD (`replace`) or
|
|
||||||
drops it (`ignore`), using exactly the same boundaries @ref
|
|
||||||
serializer::dump_escaped_impl uses while escaping a string: a byte that does
|
|
||||||
not extend the sequence started by the previous byte(s) is reread as the
|
|
||||||
start of a new one, instead of being swallowed along with them.
|
|
||||||
|
|
||||||
@pre @a error_handler is @ref error_handler_t::replace or @ref error_handler_t::ignore
|
|
||||||
@note Well-formed input is copied through unchanged, including bytes (e.g.
|
|
||||||
control characters or quotes) that @ref serializer::dump_escaped_impl
|
|
||||||
would itself escape; this function only concerns itself with
|
|
||||||
well-formedness, not with producing valid JSON text.
|
|
||||||
|
|
||||||
@param[in] s the string to sanitize
|
|
||||||
@param[in] error_handler @ref error_handler_t::replace or @ref error_handler_t::ignore
|
|
||||||
|
|
||||||
@return @a s with every ill-formed subsequence replaced or removed
|
|
||||||
|
|
||||||
@sa @ref decode
|
|
||||||
*/
|
|
||||||
template<typename StringType>
|
|
||||||
inline StringType sanitize_utf8(const StringType& s, const error_handler_t error_handler)
|
|
||||||
{
|
|
||||||
JSON_ASSERT(error_handler == error_handler_t::replace || error_handler == error_handler_t::ignore);
|
|
||||||
|
|
||||||
StringType result;
|
|
||||||
result.reserve(s.size());
|
|
||||||
|
|
||||||
std::uint32_t codepoint = 0;
|
|
||||||
std::uint8_t state = UTF8_ACCEPT;
|
|
||||||
// length of result after the last accepted code point
|
|
||||||
std::size_t result_len_after_last_accept = 0;
|
|
||||||
// whether bytes of an as yet unresolved sequence were already appended
|
|
||||||
bool pending = false;
|
|
||||||
|
|
||||||
for (std::size_t i = 0; i < s.size(); ++i)
|
|
||||||
{
|
|
||||||
switch (decode(state, codepoint, static_cast<std::uint8_t>(s[i])))
|
|
||||||
{
|
|
||||||
case UTF8_ACCEPT: // decode found a well-formed code point
|
|
||||||
{
|
|
||||||
result.push_back(s[i]);
|
|
||||||
result_len_after_last_accept = result.size();
|
|
||||||
pending = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
case UTF8_REJECT: // decode found an ill-formed byte
|
|
||||||
{
|
|
||||||
// in case we saw this byte for the first time, read it again,
|
|
||||||
// because it may be fine for itself, just not for the
|
|
||||||
// sequence that came before it
|
|
||||||
if (pending)
|
|
||||||
{
|
|
||||||
--i;
|
|
||||||
}
|
|
||||||
|
|
||||||
// drop the bytes of the ill-formed sequence buffered below
|
|
||||||
result.resize(result_len_after_last_accept);
|
|
||||||
|
|
||||||
if (error_handler == error_handler_t::replace)
|
|
||||||
{
|
|
||||||
result.append("\xEF\xBF\xBD");
|
|
||||||
result_len_after_last_accept = result.size();
|
|
||||||
}
|
|
||||||
|
|
||||||
pending = false;
|
|
||||||
state = UTF8_ACCEPT;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
default: // decode found yet incomplete multibyte code point
|
|
||||||
{
|
|
||||||
result.push_back(s[i]);
|
|
||||||
pending = true;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// the string ended with an incomplete sequence
|
|
||||||
if (state != UTF8_ACCEPT)
|
|
||||||
{
|
|
||||||
result.resize(result_len_after_last_accept);
|
|
||||||
|
|
||||||
if (error_handler == error_handler_t::replace)
|
|
||||||
{
|
|
||||||
result.append("\xEF\xBF\xBD");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace detail
|
} // namespace detail
|
||||||
NLOHMANN_JSON_NAMESPACE_END
|
NLOHMANN_JSON_NAMESPACE_END
|
||||||
|
|||||||
+497
-586
File diff suppressed because it is too large
Load Diff
@@ -12,7 +12,7 @@
|
|||||||
#include <functional> // equal_to, less
|
#include <functional> // equal_to, less
|
||||||
#include <initializer_list> // initializer_list
|
#include <initializer_list> // initializer_list
|
||||||
#include <iterator> // input_iterator_tag, iterator_traits
|
#include <iterator> // input_iterator_tag, iterator_traits
|
||||||
#include <memory> // allocator // IWYU pragma: keep
|
#include <memory> // allocator
|
||||||
#include <new> // for operator new (placement new)
|
#include <new> // for operator new (placement new)
|
||||||
#include <stdexcept> // for out_of_range
|
#include <stdexcept> // for out_of_range
|
||||||
#include <tuple> // forward_as_tuple
|
#include <tuple> // forward_as_tuple
|
||||||
@@ -74,59 +74,31 @@ template <class Key, class T, class IgnoredLess = std::less<Key>,
|
|||||||
return *this;
|
return *this;
|
||||||
}
|
}
|
||||||
|
|
||||||
private:
|
std::pair<iterator, bool> emplace(const key_type& key, T&& t)
|
||||||
/// @brief find the entry for @a key, for either constness of @a self
|
|
||||||
/// @note the single place that performs the linear key search
|
|
||||||
template<typename Self, typename KeyType>
|
|
||||||
static auto find_impl(Self& self, const KeyType& key) -> decltype(self.begin())
|
|
||||||
{
|
{
|
||||||
for (auto it = self.begin(); it != self.end(); ++it)
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
{
|
{
|
||||||
if (self.m_compare(it->first, key))
|
if (m_compare(it->first, key))
|
||||||
{
|
{
|
||||||
return it;
|
return {it, false};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return self.end();
|
append(key, std::forward<T>(t));
|
||||||
}
|
|
||||||
|
|
||||||
/// @brief remove the entry @a it points to, preserving order
|
|
||||||
/// @note keys are not movable, so the tail is destroyed and re-constructed in place
|
|
||||||
void erase_at(iterator it)
|
|
||||||
{
|
|
||||||
for (auto next = it; ++next != this->end(); ++it)
|
|
||||||
{
|
|
||||||
it->~value_type(); // Destroy but keep allocation
|
|
||||||
new (&*it) value_type{std::move(*next)};
|
|
||||||
}
|
|
||||||
Container::pop_back();
|
|
||||||
}
|
|
||||||
|
|
||||||
public:
|
|
||||||
template<class V, detail::enable_if_t<
|
|
||||||
detail::is_constructible<T, V>::value, int> = 0>
|
|
||||||
std::pair<iterator, bool> emplace(const key_type& key, V && t)
|
|
||||||
{
|
|
||||||
const auto it = find_impl(*this, key);
|
|
||||||
if (it != this->end())
|
|
||||||
{
|
|
||||||
return {it, false};
|
|
||||||
}
|
|
||||||
append(key, std::forward<V>(t));
|
|
||||||
return {std::prev(this->end()), true};
|
return {std::prev(this->end()), true};
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class KeyType, class V, detail::enable_if_t<
|
template<class KeyType, detail::enable_if_t<
|
||||||
detail::conjunction<detail::is_usable_as_key_type<key_compare, key_type, KeyType>,
|
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
||||||
detail::is_constructible<T, V>>::value, int> = 0>
|
std::pair<iterator, bool> emplace(KeyType && key, T && t)
|
||||||
std::pair<iterator, bool> emplace(KeyType && key, V && t)
|
|
||||||
{
|
{
|
||||||
const auto it = find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
if (it != this->end())
|
|
||||||
{
|
{
|
||||||
return {it, false};
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return {it, false};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
append(std::forward<KeyType>(key), std::forward<V>(t));
|
append(std::forward<KeyType>(key), std::forward<T>(t));
|
||||||
return {std::prev(this->end()), true};
|
return {std::prev(this->end()), true};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -156,55 +128,75 @@ public:
|
|||||||
|
|
||||||
T& at(const key_type& key)
|
T& at(const key_type& key)
|
||||||
{
|
{
|
||||||
const auto it = find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
if (it == this->end())
|
|
||||||
{
|
{
|
||||||
JSON_THROW(std::out_of_range("key not found"));
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return it->second;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return it->second;
|
|
||||||
|
JSON_THROW(std::out_of_range("key not found"));
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class KeyType, detail::enable_if_t<
|
template<class KeyType, detail::enable_if_t<
|
||||||
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
||||||
T & at(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-forward)
|
T & at(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-forward)
|
||||||
{
|
{
|
||||||
const auto it = find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
if (it == this->end())
|
|
||||||
{
|
{
|
||||||
JSON_THROW(std::out_of_range("key not found"));
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return it->second;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return it->second;
|
|
||||||
|
JSON_THROW(std::out_of_range("key not found"));
|
||||||
}
|
}
|
||||||
|
|
||||||
const T& at(const key_type& key) const
|
const T& at(const key_type& key) const
|
||||||
{
|
{
|
||||||
const auto it = find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
if (it == this->end())
|
|
||||||
{
|
{
|
||||||
JSON_THROW(std::out_of_range("key not found"));
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return it->second;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return it->second;
|
|
||||||
|
JSON_THROW(std::out_of_range("key not found"));
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class KeyType, detail::enable_if_t<
|
template<class KeyType, detail::enable_if_t<
|
||||||
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
||||||
const T & at(KeyType && key) const // NOLINT(cppcoreguidelines-missing-std-forward)
|
const T & at(KeyType && key) const // NOLINT(cppcoreguidelines-missing-std-forward)
|
||||||
{
|
{
|
||||||
const auto it = find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
if (it == this->end())
|
|
||||||
{
|
{
|
||||||
JSON_THROW(std::out_of_range("key not found"));
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return it->second;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return it->second;
|
|
||||||
|
JSON_THROW(std::out_of_range("key not found"));
|
||||||
}
|
}
|
||||||
|
|
||||||
size_type erase(const key_type& key)
|
size_type erase(const key_type& key)
|
||||||
{
|
{
|
||||||
const auto it = find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
if (it != this->end())
|
|
||||||
{
|
{
|
||||||
erase_at(it);
|
if (m_compare(it->first, key))
|
||||||
return 1;
|
{
|
||||||
|
// Since we cannot move const Keys, re-construct them in place
|
||||||
|
for (auto next = it; ++next != this->end(); ++it)
|
||||||
|
{
|
||||||
|
it->~value_type(); // Destroy but keep allocation
|
||||||
|
new (&*it) value_type{std::move(*next)};
|
||||||
|
}
|
||||||
|
Container::pop_back();
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
@@ -213,11 +205,19 @@ public:
|
|||||||
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
||||||
size_type erase(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-forward)
|
size_type erase(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-forward)
|
||||||
{
|
{
|
||||||
const auto it = find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
if (it != this->end())
|
|
||||||
{
|
{
|
||||||
erase_at(it);
|
if (m_compare(it->first, key))
|
||||||
return 1;
|
{
|
||||||
|
// Since we cannot move const Keys, re-construct them in place
|
||||||
|
for (auto next = it; ++next != this->end(); ++it)
|
||||||
|
{
|
||||||
|
it->~value_type(); // Destroy but keep allocation
|
||||||
|
new (&*it) value_type{std::move(*next)};
|
||||||
|
}
|
||||||
|
Container::pop_back();
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
@@ -282,38 +282,80 @@ public:
|
|||||||
|
|
||||||
size_type count(const key_type& key) const
|
size_type count(const key_type& key) const
|
||||||
{
|
{
|
||||||
return find_impl(*this, key) != this->end() ? 1 : 0;
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
|
{
|
||||||
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class KeyType, detail::enable_if_t<
|
template<class KeyType, detail::enable_if_t<
|
||||||
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
||||||
size_type count(KeyType && key) const // NOLINT(cppcoreguidelines-missing-std-forward)
|
size_type count(KeyType && key) const // NOLINT(cppcoreguidelines-missing-std-forward)
|
||||||
{
|
{
|
||||||
return find_impl(*this, key) != this->end() ? 1 : 0;
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
|
{
|
||||||
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
iterator find(const key_type& key)
|
iterator find(const key_type& key)
|
||||||
{
|
{
|
||||||
return find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
|
{
|
||||||
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return it;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Container::end();
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class KeyType, detail::enable_if_t<
|
template<class KeyType, detail::enable_if_t<
|
||||||
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
||||||
iterator find(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-forward)
|
iterator find(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-forward)
|
||||||
{
|
{
|
||||||
return find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
|
{
|
||||||
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return it;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Container::end();
|
||||||
}
|
}
|
||||||
|
|
||||||
const_iterator find(const key_type& key) const
|
const_iterator find(const key_type& key) const
|
||||||
{
|
{
|
||||||
return find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
|
{
|
||||||
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return it;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Container::end();
|
||||||
}
|
}
|
||||||
|
|
||||||
template<class KeyType, detail::enable_if_t<
|
template<class KeyType, detail::enable_if_t<
|
||||||
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
detail::is_usable_as_key_type<key_compare, key_type, KeyType>::value, int> = 0>
|
||||||
const_iterator find(KeyType && key) const // NOLINT(cppcoreguidelines-missing-std-forward)
|
const_iterator find(KeyType && key) const // NOLINT(cppcoreguidelines-missing-std-forward)
|
||||||
{
|
{
|
||||||
return find_impl(*this, key);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
|
{
|
||||||
|
if (m_compare(it->first, key))
|
||||||
|
{
|
||||||
|
return it;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Container::end();
|
||||||
}
|
}
|
||||||
|
|
||||||
std::pair<iterator, bool> insert( value_type&& value )
|
std::pair<iterator, bool> insert( value_type&& value )
|
||||||
@@ -323,10 +365,12 @@ public:
|
|||||||
|
|
||||||
std::pair<iterator, bool> insert( const value_type& value )
|
std::pair<iterator, bool> insert( const value_type& value )
|
||||||
{
|
{
|
||||||
const auto it = find_impl(*this, value.first);
|
for (auto it = this->begin(); it != this->end(); ++it)
|
||||||
if (it != this->end())
|
|
||||||
{
|
{
|
||||||
return {it, false};
|
if (m_compare(it->first, value.first))
|
||||||
|
{
|
||||||
|
return {it, false};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
append(value);
|
append(value);
|
||||||
return {--this->end(), true};
|
return {--this->end(), true};
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
+1994
-1987
File diff suppressed because it is too large
Load Diff
@@ -63,10 +63,6 @@
|
|||||||
#define JSON_STRICT_NUL_HANDLING 0
|
#define JSON_STRICT_NUL_HANDLING 0
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifndef JSON_STRICT_BINARY_UTF8
|
|
||||||
#define JSON_STRICT_BINARY_UTF8 0
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if JSON_DIAGNOSTICS
|
#if JSON_DIAGNOSTICS
|
||||||
#define NLOHMANN_JSON_ABI_TAG_DIAGNOSTICS _diag
|
#define NLOHMANN_JSON_ABI_TAG_DIAGNOSTICS _diag
|
||||||
#else
|
#else
|
||||||
@@ -103,20 +99,14 @@
|
|||||||
#define NLOHMANN_JSON_ABI_TAG_STRICT_NUL_HANDLING
|
#define NLOHMANN_JSON_ABI_TAG_STRICT_NUL_HANDLING
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if JSON_STRICT_BINARY_UTF8
|
|
||||||
#define NLOHMANN_JSON_ABI_TAG_STRICT_BINARY_UTF8 _sbu8
|
|
||||||
#else
|
|
||||||
#define NLOHMANN_JSON_ABI_TAG_STRICT_BINARY_UTF8
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifndef NLOHMANN_JSON_NAMESPACE_NO_VERSION
|
#ifndef NLOHMANN_JSON_NAMESPACE_NO_VERSION
|
||||||
#define NLOHMANN_JSON_NAMESPACE_NO_VERSION 0
|
#define NLOHMANN_JSON_NAMESPACE_NO_VERSION 0
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// Construct the namespace ABI tags component
|
// Construct the namespace ABI tags component
|
||||||
#define NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b, c, d, e, f, g) json_abi ## a ## b ## c ## d ## e ## f ## g
|
#define NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b, c, d, e, f) json_abi ## a ## b ## c ## d ## e ## f
|
||||||
#define NLOHMANN_JSON_ABI_TAGS_CONCAT(a, b, c, d, e, f, g) \
|
#define NLOHMANN_JSON_ABI_TAGS_CONCAT(a, b, c, d, e, f) \
|
||||||
NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b, c, d, e, f, g)
|
NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b, c, d, e, f)
|
||||||
|
|
||||||
#define NLOHMANN_JSON_ABI_TAGS \
|
#define NLOHMANN_JSON_ABI_TAGS \
|
||||||
NLOHMANN_JSON_ABI_TAGS_CONCAT( \
|
NLOHMANN_JSON_ABI_TAGS_CONCAT( \
|
||||||
@@ -125,8 +115,7 @@
|
|||||||
NLOHMANN_JSON_ABI_TAG_DIAGNOSTIC_POSITIONS, \
|
NLOHMANN_JSON_ABI_TAG_DIAGNOSTIC_POSITIONS, \
|
||||||
NLOHMANN_JSON_ABI_TAG_BRACE_INIT_COPY_SEMANTICS, \
|
NLOHMANN_JSON_ABI_TAG_BRACE_INIT_COPY_SEMANTICS, \
|
||||||
NLOHMANN_JSON_ABI_TAG_PRECISE_STREAM_POSITION, \
|
NLOHMANN_JSON_ABI_TAG_PRECISE_STREAM_POSITION, \
|
||||||
NLOHMANN_JSON_ABI_TAG_STRICT_NUL_HANDLING, \
|
NLOHMANN_JSON_ABI_TAG_STRICT_NUL_HANDLING)
|
||||||
NLOHMANN_JSON_ABI_TAG_STRICT_BINARY_UTF8)
|
|
||||||
|
|
||||||
// Construct the namespace version component
|
// Construct the namespace version component
|
||||||
#define NLOHMANN_JSON_NAMESPACE_VERSION_CONCAT_EX(major, minor, patch) \
|
#define NLOHMANN_JSON_NAMESPACE_VERSION_CONCAT_EX(major, minor, patch) \
|
||||||
|
|||||||
@@ -44,10 +44,6 @@ TEST_CASE("default namespace")
|
|||||||
expected += "_snul";
|
expected += "_snul";
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if JSON_STRICT_BINARY_UTF8
|
|
||||||
expected += "_sbu8";
|
|
||||||
#endif
|
|
||||||
|
|
||||||
expected += "_v" STRINGIZE(NLOHMANN_JSON_VERSION_MAJOR);
|
expected += "_v" STRINGIZE(NLOHMANN_JSON_VERSION_MAJOR);
|
||||||
expected += "_" STRINGIZE(NLOHMANN_JSON_VERSION_MINOR);
|
expected += "_" STRINGIZE(NLOHMANN_JSON_VERSION_MINOR);
|
||||||
expected += "_" STRINGIZE(NLOHMANN_JSON_VERSION_PATCH) "::basic_json";
|
expected += "_" STRINGIZE(NLOHMANN_JSON_VERSION_PATCH) "::basic_json";
|
||||||
|
|||||||
@@ -45,10 +45,6 @@ TEST_CASE("default namespace without version component")
|
|||||||
expected += "_snul";
|
expected += "_snul";
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if JSON_STRICT_BINARY_UTF8
|
|
||||||
expected += "_sbu8";
|
|
||||||
#endif
|
|
||||||
|
|
||||||
expected += "::basic_json";
|
expected += "::basic_json";
|
||||||
|
|
||||||
// fallback for Clang
|
// fallback for Clang
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user