JSON for Modern C++ version 3.11.3

[nlohmann]

Release date: 2023-11-28
SHA-256: 9bea4c8066ef4a1c206b2be5a36302f8926f7fdc6087af5d20b417d0cf103ea6 (json.hpp), a22461d13119ac5c78f205d3df1db13403e58ce1bb1794edc9313677313f4a9d (include.zip), d6c65aca6b1ed68e7a182f4757257b107ae403032760ed6ef121c9d55e81757d (json.tar.xz)

Summary

This release fixes some bugs found in the 3.11.2 release.

All changes are backward-compatible.

💰 Note you can support this project via GitHub sponsors or PayPal.

✨ New Features

• Allow custom base class as node customization point. This adds an additional template parameter which allows to set a custom base class for nlohmann::json. This class serves as an extension point and allows to add functionality to json node. Examples for such functionality might be metadata or additional member functions (e.g., visitors) or other application specific code. By default the parameter is set to void and an empty base class is used. In this case the library behaves as it already did. Allow custom base class as node customization point #3110
• Add more specific parse error message when attempting to parse empty input. Improve wording of parse_error exception #4037 Add more specific error message when attempting to parse empty input #4180
• Add serialization-only user defined type macros (NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE and NLOHMANN_DEFINE_TYPE_INTRUSIVE_ONLY_SERIALIZE). Add serialization-only user defined type macros #3816
• Add Bazel build support. If you are using Bazel you can simply reference this repository using http_archive or git_repository and depend on @nlohmann_json//:json. Add Bazel build support #3709
• Support Apple's Swift Package Manager. Support Apple's Swift Package Manager #4010

🐛 Bug Fixes

• Adjust CMake files to accept NEW CMake policies up to CMake 3.14. This fixes a nasty deprecation warning that "Compatibility with CMake < 3.5 will be removed from a future version of CMake". Upgrade CMake minimum version #4076 Accept NEW CMake policies up to CMake 3.14 #4112
• Fix CMake header path in install with custom CMAKE_INSTALL_INCLUDEDIR. fix cmake header path in install with custom CMAKE_INSTALL_INCLUDEDIR #4194
• Add missing <numeric> header include. Compilation error with JSON_DIAGNOSTICS enabled #3717 #3717: fix compilation error: "execeptions.hpp:119 accumulate is not … #3718 Add missing <numeric> include #3719
• Replace uses of INT_MIN/INT_MAX, etc. with std::numeric_limits and consistently use std-namespaced integer types to make library work with newer GCC versions. INT64_MIN/MAX not defined for newer g++ #3722 Replace limit macros with std::numeric_limits #3723
• Add missing files (json_fwd.hpp and Bazel build files) to release artifact include.zip. Amalgated json_fwd.hpp not included in include.zip #3727 Add missing files to release artifacts #3728
• Fix 'declaration hides global declaration' warning. Fix 'declaration hides global declaration' warning #3751
• Fix natvis XML. Generated natvis is invalid XML #3858 Fix natvis XML #3863
• Fix warning about moved from object. Code analysis warning string_concat.hpp C26800: Use of a moved from object #3805 Fix warning about moved from object #3889
• Remove a magic number to fix a warning. decode(state, codep, byte) generates warnings. #3837 Remove a magic number #3888
• Fix debug pretty-printer by checking if match is valid before accessing group. json pretty printer causes python exceptions on non-json types #3919 PrettyPrinter: Check if match is valid before accessing group #3920
• Fix custom allocators by defining missing rebind type. custom allocators: define missing 'rebind' type #3895 GCC 13 build failures #3927
• Prevent memory leak when exception is thrown in adl_serializer::to_json Memory leak when exception is thrown in adl_serializer::to_json #3881 Prevent memory leak when exception is thrown in adl_serializer::to_json #3901
• Fix Clang-Tidy warnings. Fix Clang-Tidy warnings #4047
• Fix init-list construction when size_type is not int. Fixed init-list construction when size_type is not int #4140
• Fix deprecation warning "identifier _json preceded by whitespace in a literal operator declaration". LLVM 16.0.6 issues warning for literal operators when Wdeprecated-literal-operator #4129 Fix deprecation warning #4161
• Fix compile error with _HAS_STATIC_RTTI=0. Fix compile error with _HAS_STATIC_RTTI=0 #4046
• Fix char_traits deprecation warning "char_traits<unsigned char> is deprecated: char_traits<T> for T not equal to char, wchar_t, char8_t, char16_t or char32_t is non-standard". Deprecation warning about std::char_traits<unsigned char> #4163 Fix char_traits deprecation warning #4179

🔨 Further Changes

CI

• Use official Clang/GCC Docker containers in the CI. Use official Clang/GCC containers #3703
• Add workflow to check if the source files are amalgamated. Add 'Check amalgamation' workflow #3693
• Fix CI build. Add clang-tools to required tools for ci_static_analysis_clang #3724 Fix pipeline #3862 Fix CI #3978 Fix CI + new Doctest #3985 Help needed to fix CI #4025 Fix CI, again #4083 Fix CI #4160 Fix CI (again) #4196 Fix failing CI checks #4215
• Use Clang 15. Add Clang 15 #3822 Clang 15 #3876
• Add CIFuzz CI GitHub action. Add CIFuzz CI GitHub action #3845
• Fix MinGW script and CI. Try old MinGW script #3892 Fix MinGW CI #4175
• Removed lgtm and DroneCI and added Cirrus CI. Check Drone CI #3890 Fix CI issues #3906 Clean up badges #3935 3935, removed lgtm badge and added Cirrus CI badge #3937
• Set minimal permissions to Github Workflows. Set minimal permissions to Github Workflows #3971 Set minimal permissions to Github Workflows #3972
• Refactor amalgamation workflow to avoid dangerous use of pull_request_target. Dangerous use of pull_request_target #3945 Refactor amalgamation workflow to avoid dangerous use of pull_request_target #3969

Documentation

• Add migration guide to replace deprecated library functions. Add migration guide #3702 Add migration guide #3887
• Add dark mode toggle to documentation Add dark mode toggle to documentation #3726
• Fix typos in documentation. Fix typos in .md files #3748 Fix some typos for n-dimensional arrays #3767 Typo in cmake/test.cmake #3902 Change 2022 to 2023 #3932 Fix typo in test.cmake #3951 Fix typo in afl_driver.cpp #4109 Update CODEOWNERS #4126 Correct a typo in serve_header/README.md #4143 Update index.md #4149 Update index.md #4159 Fix spellcheck issue #4173
• Update Codacy link. Update Codacy link #3740
• Bump documentation tool versions. Bump joblib from 1.1.0 to 1.2.0 in /docs/mkdocs #3781 Bump certifi from 2022.6.15 to 2022.12.7 in /docs/mkdocs #3872 Upgrade Python packages #3891 ⬆️ Bump future from 0.18.2 to 0.18.3 in /docs/mkdocs #3934
• Add vcpkg port version badge. Add Vcpkg port version badge #3988
• Add to CONTRIBUTING.md that make pretty is required for test updates. Add to CONTRIBUTING.md that make pretty is required for test updates. #4045
• Use template get instead of get in examples. Compile Error on g++ using get() function #3827 Explicit conversion example in docs should use template get #4038 Use template get instead of get in examples #4039
• Capture exceptions by const& in docs. Capture exceptions by const& in docs. #4099
• Fix source highlighting in user defined type macros docs. Fix source highlighting in user defined type macros docs #4169

Tests

• Use std::ranges::equals for range comparisons in test case. GCC 13 build failures #3927 tests/unit-iterators2: use std::ranges::equals for range comparisons #3950
• Add more algorithm tests to unit-algorithm.cpp. Added to tests the file unit-algorithm.cpp (c++ 11) functions from algorithm library #4044

🔥 Deprecated functions

This release does not deprecate any function. See the migration guide for help adjusting your code for future versions.

The following functions have been deprecated in earlier versions and will be removed in the next major version (i.e., 4.0.0):

• The function iterator_wrapper is deprecated. Please use the member function items() instead.
• Functions friend std::istream& operator<<(basic_json&, std::istream&) and friend std::ostream& operator>>(const basic_json&, std::ostream&) are deprecated. Please use friend std::istream& operator>>(std::istream&, basic_json&) and friend operator<<(std::ostream&, const basic_json&) instead.
• Passing iterator pairs or pointer/length pairs to parsing functions (basic_json::parse, basic_json::accept, basic_json::sax_parse, basic_json::from_cbor, basic_json::from_msgpack, basic_json::from_ubjson, basic_json::from_bson) via initializer lists is deprecated. Instead, pass two iterators; for instance, call basic_json::from_cbor(ptr, ptr+len) instead of basic_json::from_cbor({ptr, len}).
• The implicit conversion from JSON Pointers to string (json_pointer::operator string_t) is deprecated. Use json_pointer::to_string instead.
• Comparing JSON Pointers with strings via operator== and operator!= have been deprecated. To compare a json_pointer p with a string s, convert s to a json_pointer first and use json_pointer::operator== or json_pointer::operator!=. Deprecate json_pointer/string_t comparisons #3684

All deprecations are annotated with HEDLEY_DEPRECATED_FOR to report which function to use instead.

---

This discussion was created from the release JSON for Modern C++ version 3.11.3.

[gregmarr]

Typo area instead of are

• Add workflow to check if the source files area amalgamated.

[GrishaKirilin]

"with never GCC versions" -> "with newer GCC versions"?

[BillD12345]

how to use it? my vs just say there no suck file or directory

[nlohmann]

See https://json.nlohmann.me/integration/

[BillD12345]

thank you i manage to use nlohmann/json its a bit hard to use

[wwwqr-000]

#include "path/to/file/json.hpp"