Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ArthurSonzogni/nlohmann_json_cmake_fetchcontent.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArthurSonzogni <sonzogniarthur@gmail.com>2022-09-25 15:57:20 +0300
committerArthurSonzogni <sonzogniarthur@gmail.com>2022-09-25 15:57:20 +0300
commit13132dd361c8c5b5753983d5186cf54f689d90f9 (patch)
treef349bb99da49ee7b0568ceb1e4901f6368bd270f
parent97795502d1824062547085e9e329d0c0d0c499f3 (diff)
Upstream release v3.10.5v3.10.5
Diffstat
-rw-r--r--CMakeLists.txt207
-rw-r--r--LICENSE.MIT2
-rw-r--r--README.md2
-rw-r--r--cmake/ci.cmake1
-rw-r--r--cmake/config.cmake.in2
-rw-r--r--cmake/download_test_data.cmake56
-rw-r--r--cmake/nlohmann_jsonConfigVersion.cmake.in2
-rw-r--r--cmake/pkg-config.pc.in4
-rw-r--r--meson.build24
-rw-r--r--single_include/nlohmann/json.hpp (renamed from include/nlohmann/json.hpp)6236
-rw-r--r--single_include/nlohmann/json_fwd.hpp (renamed from include/nlohmann/json_fwd.hpp)34
-rw-r--r--test/CMakeLists.txt1
12 files changed, 1042 insertions, 5529 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index a30b398..b93c6e4 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,20 +1,50 @@
cmake_minimum_required(VERSION 3.1)
-project(nlohmann_json LANGUAGES CXX)
-
-add_library(nlohmann_json INTERFACE)
-add_library(nlohmann_json::nlohmann_json ALIAS nlohmann_json)
-target_include_directories(nlohmann_json
- INTERFACE
- $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
- $<INSTALL_INTERFACE:include/nlohmann>
-)
-if (${CMAKE_VERSION} VERSION_LESS "3.8.0")
- target_compile_features(nlohmann_json INTERFACE cxx_range_for)
-else()
- target_compile_features(nlohmann_json INTERFACE cxx_std_11)
+##
+## PROJECT
+## name and version
+##
+project(nlohmann_json VERSION 3.10.5 LANGUAGES CXX)
+
+##
+## MAIN_PROJECT CHECK
+## determine if nlohmann_json is built as a subproject (using add_subdirectory) or if it is the main project
+##
+set(MAIN_PROJECT OFF)
+if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+ set(MAIN_PROJECT ON)
endif()
+##
+## INCLUDE
+##
+##
+include(ExternalProject)
+
+##
+## OPTIONS
+##
+
+if (POLICY CMP0077)
+ # Allow CMake 3.13+ to override options when using FetchContent / add_subdirectory.
+ cmake_policy(SET CMP0077 NEW)
+endif ()
+
+option(JSON_BuildTests "Build the unit tests when BUILD_TESTING is enabled." ${MAIN_PROJECT})
+option(JSON_CI "Enable CI build targets." OFF)
+option(JSON_Diagnostics "Use extended diagnostic messages." OFF)
+option(JSON_ImplicitConversions "Enable implicit conversions." ON)
+option(JSON_Install "Install CMake targets during install step." ${MAIN_PROJECT})
+option(JSON_MultipleHeaders "Use non-amalgamated version of the library." OFF)
+option(JSON_SystemInclude "Include as system headers (skip for clang-tidy)." OFF)
+
+if (JSON_CI)
+ include(cmake/ci.cmake)
+endif ()
+
+##
+## CONFIGURATION
+##
include(GNUInstallDirs)
set(NLOHMANN_JSON_TARGET_NAME ${PROJECT_NAME})
@@ -26,52 +56,133 @@ set(NLOHMANN_JSON_CMAKE_CONFIG_DIR "${CMAKE_CURRENT_BINARY_DIR}")
set(NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}ConfigVersion.cmake")
set(NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Config.cmake")
set(NLOHMANN_JSON_CMAKE_PROJECT_TARGETS_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Targets.cmake")
+set(NLOHMANN_JSON_PKGCONFIG_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}/pkgconfig")
+
+if (JSON_MultipleHeaders)
+ set(NLOHMANN_JSON_INCLUDE_BUILD_DIR "${PROJECT_SOURCE_DIR}/include/")
+ message(STATUS "Using the multi-header code from ${NLOHMANN_JSON_INCLUDE_BUILD_DIR}")
+else()
+ set(NLOHMANN_JSON_INCLUDE_BUILD_DIR "${PROJECT_SOURCE_DIR}/single_include/")
+ message(STATUS "Using the single-header code from ${NLOHMANN_JSON_INCLUDE_BUILD_DIR}")
+endif()
+
+if (NOT JSON_ImplicitConversions)
+ message(STATUS "Implicit conversions are disabled")
+endif()
+
+if (JSON_Diagnostics)
+ message(STATUS "Diagnostics enabled")
+endif()
+
+if (JSON_SystemInclude)
+ set(NLOHMANN_JSON_SYSTEM_INCLUDE "SYSTEM")
+endif()
##
-## INSTALL
-## install header files, generate and install cmake config files for find_package()
+## TARGET
+## create target and add include path
##
-include(CMakePackageConfigHelpers)
+add_library(${NLOHMANN_JSON_TARGET_NAME} INTERFACE)
+add_library(${PROJECT_NAME}::${NLOHMANN_JSON_TARGET_NAME} ALIAS ${NLOHMANN_JSON_TARGET_NAME})
+if (${CMAKE_VERSION} VERSION_LESS "3.8.0")
+ target_compile_features(${NLOHMANN_JSON_TARGET_NAME} INTERFACE cxx_range_for)
+else()
+ target_compile_features(${NLOHMANN_JSON_TARGET_NAME} INTERFACE cxx_std_11)
+endif()
-# use a custom package version config file instead of
-# write_basic_package_version_file to ensure that it's architecture-independent
-# https://github.com/nlohmann/json/issues/1697
-configure_file(
- "cmake/nlohmann_jsonConfigVersion.cmake.in"
- ${NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE}
- @ONLY
+target_compile_definitions(
+ ${NLOHMANN_JSON_TARGET_NAME}
+ INTERFACE
+ JSON_USE_IMPLICIT_CONVERSIONS=$<BOOL:${JSON_ImplicitConversions}>
+ JSON_DIAGNOSTICS=$<BOOL:${JSON_Diagnostics}>
)
-configure_file(
- ${NLOHMANN_JSON_CMAKE_CONFIG_TEMPLATE}
- ${NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE}
- @ONLY
+target_include_directories(
+ ${NLOHMANN_JSON_TARGET_NAME}
+ ${NLOHMANN_JSON_SYSTEM_INCLUDE} INTERFACE
+ $<BUILD_INTERFACE:${NLOHMANN_JSON_INCLUDE_BUILD_DIR}>
+ $<INSTALL_INTERFACE:include>
)
-install(
- DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/nlohmann
- DESTINATION ${NLOHMANN_JSON_INCLUDE_INSTALL_DIR}
-)
+## add debug view definition file for msvc (natvis)
+if (MSVC)
+ set(NLOHMANN_ADD_NATVIS TRUE)
+ set(NLOHMANN_NATVIS_FILE "nlohmann_json.natvis")
+ target_sources(
+ ${NLOHMANN_JSON_TARGET_NAME}
+ INTERFACE
+ $<INSTALL_INTERFACE:${NLOHMANN_NATVIS_FILE}>
+ $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/${NLOHMANN_NATVIS_FILE}>
+ )
+endif()
-install(
- FILES ${NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE} ${NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE}
- DESTINATION ${NLOHMANN_JSON_CONFIG_INSTALL_DIR}
+# Install a pkg-config file, so other tools can find this.
+CONFIGURE_FILE(
+ "${CMAKE_CURRENT_SOURCE_DIR}/cmake/pkg-config.pc.in"
+ "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
)
-export(
- TARGETS ${NLOHMANN_JSON_TARGET_NAME}
- NAMESPACE ${PROJECT_NAME}::
- FILE ${NLOHMANN_JSON_CMAKE_PROJECT_TARGETS_FILE}
-)
+##
+## TESTS
+## create and configure the unit test target
+##
+if (JSON_BuildTests)
+ include(CTest)
+ enable_testing()
+ add_subdirectory(test)
+endif()
-install(
- TARGETS ${NLOHMANN_JSON_TARGET_NAME}
- EXPORT ${NLOHMANN_JSON_TARGETS_EXPORT_NAME}
- INCLUDES DESTINATION ${NLOHMANN_JSON_INCLUDE_INSTALL_DIR}
+##
+## INSTALL
+## install header files, generate and install cmake config files for find_package()
+##
+include(CMakePackageConfigHelpers)
+# use a custom package version config file instead of
+# write_basic_package_version_file to ensure that it's architecture-independent
+# https://github.com/nlohmann/json/issues/1697
+configure_file(
+ "cmake/nlohmann_jsonConfigVersion.cmake.in"
+ ${NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE}
+ @ONLY
)
-
-install(
- EXPORT ${NLOHMANN_JSON_TARGETS_EXPORT_NAME}
- NAMESPACE ${PROJECT_NAME}::
- DESTINATION ${NLOHMANN_JSON_CONFIG_INSTALL_DIR}
+configure_file(
+ ${NLOHMANN_JSON_CMAKE_CONFIG_TEMPLATE}
+ ${NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE}
+ @ONLY
)
+
+if(JSON_Install)
+ install(
+ DIRECTORY ${NLOHMANN_JSON_INCLUDE_BUILD_DIR}
+ DESTINATION ${NLOHMANN_JSON_INCLUDE_INSTALL_DIR}
+ )
+ install(
+ FILES ${NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE} ${NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE}
+ DESTINATION ${NLOHMANN_JSON_CONFIG_INSTALL_DIR}
+ )
+ if (NLOHMANN_ADD_NATVIS)
+ install(
+ FILES ${NLOHMANN_NATVIS_FILE}
+ DESTINATION .
+ )
+ endif()
+ export(
+ TARGETS ${NLOHMANN_JSON_TARGET_NAME}
+ NAMESPACE ${PROJECT_NAME}::
+ FILE ${NLOHMANN_JSON_CMAKE_PROJECT_TARGETS_FILE}
+ )
+ install(
+ TARGETS ${NLOHMANN_JSON_TARGET_NAME}
+ EXPORT ${NLOHMANN_JSON_TARGETS_EXPORT_NAME}
+ INCLUDES DESTINATION ${NLOHMANN_JSON_INCLUDE_INSTALL_DIR}
+ )
+ install(
+ EXPORT ${NLOHMANN_JSON_TARGETS_EXPORT_NAME}
+ NAMESPACE ${PROJECT_NAME}::
+ DESTINATION ${NLOHMANN_JSON_CONFIG_INSTALL_DIR}
+ )
+ install(
+ FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
+ DESTINATION ${NLOHMANN_JSON_PKGCONFIG_INSTALL_DIR}
+ )
+endif()
diff --git a/LICENSE.MIT b/LICENSE.MIT
index 00599af..1c1f7a6 100644
--- a/LICENSE.MIT
+++ b/LICENSE.MIT
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) 2013-2017 Niels Lohmann
+Copyright (c) 2013-2022 Niels Lohmann
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index d3af9a2..82e83cc 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ FetchContent_Declare(json
GIT_REPOSITORY https://github.com/ArthurSonzogni/nlohmann_json_cmake_fetchcontent
GIT_PROGRESS TRUE
GIT_SHALLOW TRUE
- GIT_TAG v3.10.4)
+ GIT_TAG v3.10.5)
FetchContent_MakeAvailable(json)
diff --git a/cmake/ci.cmake b/cmake/ci.cmake
new file mode 100644
index 0000000..0897869
--- /dev/null
+++ b/cmake/ci.cmake
@@ -0,0 +1 @@
+message(FATAL_ERROR "The JSON_CI option is not availablewhen using the nlohmann_json_cmake_fetchcontent repository.") \ No newline at end of file
diff --git a/cmake/config.cmake.in b/cmake/config.cmake.in
index 824412d..9a17a7d 100644
--- a/cmake/config.cmake.in
+++ b/cmake/config.cmake.in
@@ -12,4 +12,4 @@ if(NOT TARGET @PROJECT_NAME@::@NLOHMANN_JSON_TARGET_NAME@)
INTERFACE_LINK_LIBRARIES @PROJECT_NAME@::@NLOHMANN_JSON_TARGET_NAME@
)
endif()
-endif() \ No newline at end of file
+endif()
diff --git a/cmake/download_test_data.cmake b/cmake/download_test_data.cmake
new file mode 100644
index 0000000..f516a7c
--- /dev/null
+++ b/cmake/download_test_data.cmake
@@ -0,0 +1,56 @@
+set(JSON_TEST_DATA_URL https://github.com/nlohmann/json_test_data)
+set(JSON_TEST_DATA_VERSION 3.0.0)
+
+# if variable is set, use test data from given directory rather than downloading them
+if(JSON_TestDataDirectory)
+ message(STATUS "Using test data in ${JSON_TestDataDirectory}.")
+ add_custom_target(download_test_data)
+ file(WRITE ${CMAKE_BINARY_DIR}/include/test_data.hpp "#define TEST_DATA_DIRECTORY \"${JSON_TestDataDirectory}\"\n")
+else()
+ find_package(Git)
+ # target to download test data
+ add_custom_target(download_test_data
+ COMMAND test -d json_test_data || ${GIT_EXECUTABLE} clone -c advice.detachedHead=false --branch v${JSON_TEST_DATA_VERSION} ${JSON_TEST_DATA_URL}.git --quiet --depth 1
+ COMMENT "Downloading test data from ${JSON_TEST_DATA_URL} (v${JSON_TEST_DATA_VERSION})"
+ WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+ )
+ # create a header with the path to the downloaded test data
+ file(WRITE ${CMAKE_BINARY_DIR}/include/test_data.hpp "#define TEST_DATA_DIRECTORY \"${CMAKE_BINARY_DIR}/json_test_data\"\n")
+endif()
+
+# determine the operating system (for debug and support purposes)
+find_program(UNAME_COMMAND uname)
+find_program(VER_COMMAND ver)
+find_program(LSB_RELEASE_COMMAND lsb_release)
+find_program(SW_VERS_COMMAND sw_vers)
+set(OS_VERSION_STRINGS "${CMAKE_SYSTEM}")
+if (VER_COMMAND)
+ execute_process(COMMAND ${VER_COMMAND} OUTPUT_VARIABLE VER_COMMAND_RESULT OUTPUT_STRIP_TRAILING_WHITESPACE)
+ set(OS_VERSION_STRINGS "${OS_VERSION_STRINGS}; ${VER_COMMAND_RESULT}")
+endif()
+if (SW_VERS_COMMAND)
+ execute_process(COMMAND ${SW_VERS_COMMAND} OUTPUT_VARIABLE SW_VERS_COMMAND_RESULT OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
+ string(REGEX REPLACE "[ ]*\n" "; " SW_VERS_COMMAND_RESULT "${SW_VERS_COMMAND_RESULT}")
+ set(OS_VERSION_STRINGS "${OS_VERSION_STRINGS}; ${SW_VERS_COMMAND_RESULT}")
+endif()
+if (LSB_RELEASE_COMMAND)
+ execute_process(COMMAND ${LSB_RELEASE_COMMAND} -a OUTPUT_VARIABLE LSB_RELEASE_COMMAND_RESULT OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
+ string(REGEX REPLACE "[ ]*\n" "; " LSB_RELEASE_COMMAND_RESULT "${LSB_RELEASE_COMMAND_RESULT}")
+ set(OS_VERSION_STRINGS "${OS_VERSION_STRINGS}; ${LSB_RELEASE_COMMAND_RESULT}")
+endif()
+if (UNAME_COMMAND)
+ execute_process(COMMAND ${UNAME_COMMAND} -a OUTPUT_VARIABLE UNAME_COMMAND_RESULT OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
+ set(OS_VERSION_STRINGS "${OS_VERSION_STRINGS}; ${UNAME_COMMAND_RESULT}")
+endif()
+
+message(STATUS "Operating system: ${OS_VERSION_STRINGS}")
+
+# determine the compiler (for debug and support purposes)
+if (MSVC)
+ execute_process(COMMAND ${CMAKE_CXX_COMPILER} OUTPUT_VARIABLE CXX_VERSION_RESULT OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_VARIABLE CXX_VERSION_RESULT ERROR_STRIP_TRAILING_WHITESPACE)
+ set(CXX_VERSION_RESULT "${CXX_VERSION_RESULT}; MSVC_VERSION=${MSVC_VERSION}; MSVC_TOOLSET_VERSION=${MSVC_TOOLSET_VERSION}")
+else()
+ execute_process(COMMAND ${CMAKE_CXX_COMPILER} --version OUTPUT_VARIABLE CXX_VERSION_RESULT OUTPUT_STRIP_TRAILING_WHITESPACE)
+endif()
+string(REGEX REPLACE "[ ]*\n" "; " CXX_VERSION_RESULT "${CXX_VERSION_RESULT}")
+message(STATUS "Compiler: ${CXX_VERSION_RESULT}")
diff --git a/cmake/nlohmann_jsonConfigVersion.cmake.in b/cmake/nlohmann_jsonConfigVersion.cmake.in
index 38ab828..1091085 100644
--- a/cmake/nlohmann_jsonConfigVersion.cmake.in
+++ b/cmake/nlohmann_jsonConfigVersion.cmake.in
@@ -17,4 +17,4 @@ else()
if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
set(PACKAGE_VERSION_EXACT TRUE)
endif()
-endif() \ No newline at end of file
+endif()
diff --git a/cmake/pkg-config.pc.in b/cmake/pkg-config.pc.in
new file mode 100644
index 0000000..d36317f
--- /dev/null
+++ b/cmake/pkg-config.pc.in
@@ -0,0 +1,4 @@
+Name: ${PROJECT_NAME}
+Description: JSON for Modern C++
+Version: ${PROJECT_VERSION}
+Cflags: -I${CMAKE_INSTALL_FULL_INCLUDEDIR}
diff --git a/meson.build b/meson.build
index 3cc6c76..d61dc25 100644
--- a/meson.build
+++ b/meson.build
@@ -1,7 +1,23 @@
-project('nlohmann_json', 'cpp')
-
-nlohmann_json_inc = include_directories('include')
+project('nlohmann_json',
+ 'cpp',
+ version : '3.10.5',
+ license : 'MIT',
+)
nlohmann_json_dep = declare_dependency(
- include_directories : nlohmann_json_inc
+ include_directories: include_directories('single_include')
+)
+
+nlohmann_json_multiple_headers = declare_dependency(
+ include_directories: include_directories('include')
+)
+
+if not meson.is_subproject()
+install_headers('single_include/nlohmann/json.hpp', subdir: 'nlohmann')
+
+pkgc = import('pkgconfig')
+pkgc.generate(name: 'nlohmann_json',
+ version: meson.project_version(),
+ description: 'JSON for Modern C++'
)
+endif
diff --git a/include/nlohmann/json.hpp b/single_include/nlohmann/json.hpp
index 87475ab..cb27e05 100644
--- a/include/nlohmann/json.hpp
+++ b/single_include/nlohmann/json.hpp
@@ -1,12 +1,12 @@
/*
__ _____ _____ _____
__| | __| | | | JSON for Modern C++
-| | |__ | | | | | | version 3.10.4
+| | |__ | | | | | | version 3.10.5
|_____|_____|_____|_|___| https://github.com/nlohmann/json
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
SPDX-License-Identifier: MIT
-Copyright (c) 2013-2019 Niels Lohmann <http://nlohmann.me>.
+Copyright (c) 2013-2022 Niels Lohmann <http://nlohmann.me>.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -27,12 +27,21 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
+/****************************************************************************\
+ * Note on documentation: The source files contain links to the online *
+ * documentation of the public API at https://json.nlohmann.me. This URL *
+ * contains the most recent documentation and should also be applicable to *
+ * previous versions; documentation for deprecated functions is not *
+ * removed, but marked deprecated. See "Generate documentation" section in *
+ * file doc/README.md. *
+\****************************************************************************/
+
#ifndef INCLUDE_NLOHMANN_JSON_HPP_
#define INCLUDE_NLOHMANN_JSON_HPP_
#define NLOHMANN_JSON_VERSION_MAJOR 3
#define NLOHMANN_JSON_VERSION_MINOR 10
-#define NLOHMANN_JSON_VERSION_PATCH 4
+#define NLOHMANN_JSON_VERSION_PATCH 5
#include <algorithm> // all_of, find, for_each
#include <cstddef> // nullptr_t, ptrdiff_t, size_t
@@ -2325,6 +2334,66 @@ using is_detected_convertible =
#define JSON_HAS_CPP_11
#endif
+#if !defined(JSON_HAS_FILESYSTEM) && !defined(JSON_HAS_EXPERIMENTAL_FILESYSTEM)
+ #ifdef JSON_HAS_CPP_17
+ #if defined(__cpp_lib_filesystem)
+ #define JSON_HAS_FILESYSTEM 1
+ #elif defined(__cpp_lib_experimental_filesystem)
+ #define JSON_HAS_EXPERIMENTAL_FILESYSTEM 1
+ #elif !defined(__has_include)
+ #define JSON_HAS_EXPERIMENTAL_FILESYSTEM 1
+ #elif __has_include(<filesystem>)
+ #define JSON_HAS_FILESYSTEM 1
+ #elif __has_include(<experimental/filesystem>)
+ #define JSON_HAS_EXPERIMENTAL_FILESYSTEM 1
+ #endif
+
+ // std::filesystem does not work on MinGW GCC 8: https://sourceforge.net/p/mingw-w64/bugs/737/
+ #if defined(__MINGW32__) && defined(__GNUC__) && __GNUC__ == 8
+ #undef JSON_HAS_FILESYSTEM
+ #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
+ #endif
+
+ // no filesystem support before GCC 8: https://en.cppreference.com/w/cpp/compiler_support
+ #if defined(__GNUC__) && !defined(__clang__) && __GNUC__ < 8
+ #undef JSON_HAS_FILESYSTEM
+ #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
+ #endif
+
+ // no filesystem support before Clang 7: https://en.cppreference.com/w/cpp/compiler_support
+ #if defined(__clang_major__) && __clang_major__ < 7
+ #undef JSON_HAS_FILESYSTEM
+ #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
+ #endif
+
+ // no filesystem support before MSVC 19.14: https://en.cppreference.com/w/cpp/compiler_support
+ #if defined(_MSC_VER) && _MSC_VER < 1940
+ #undef JSON_HAS_FILESYSTEM
+ #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
+ #endif
+
+ // no filesystem support before iOS 13
+ #if defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < 130000
+ #undef JSON_HAS_FILESYSTEM
+ #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
+ #endif
+
+ // no filesystem support before macOS Catalina
+ #if defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < 101500
+ #undef JSON_HAS_FILESYSTEM
+ #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
+ #endif
+ #endif
+#endif
+
+#ifndef JSON_HAS_EXPERIMENTAL_FILESYSTEM
+ #define JSON_HAS_EXPERIMENTAL_FILESYSTEM 0
+#endif
+
+#ifndef JSON_HAS_FILESYSTEM
+ #define JSON_HAS_FILESYSTEM 0
+#endif
+
// disable documentation warnings on clang
#if defined(__clang__)
#pragma clang diagnostic push
@@ -2332,7 +2401,7 @@ using is_detected_convertible =
#pragma clang diagnostic ignored "-Wdocumentation-unknown-command"
#endif
-// allow to disable exceptions
+// allow disabling exceptions
#if (defined(__cpp_exceptions) || defined(__EXCEPTIONS) || defined(_CPPUNWIND)) && !defined(JSON_NOEXCEPTION)
#define JSON_THROW(exception) throw exception
#define JSON_TRY try
@@ -2366,7 +2435,7 @@ using is_detected_convertible =
#define JSON_INTERNAL_CATCH JSON_INTERNAL_CATCH_USER
#endif
-// allow to override assert
+// allow overriding assert
#if !defined(JSON_ASSERT)
#include <cassert> // assert
#define JSON_ASSERT(x) assert(x)
@@ -2734,34 +2803,8 @@ namespace detail
// exceptions //
////////////////
-/*!
-@brief general exception of the @ref basic_json class
-
-This class is an extension of `std::exception` objects with a member @a id for
-exception ids. It is used as the base class for all exceptions thrown by the
-@ref basic_json class. This class can hence be used as "wildcard" to catch
-exceptions.
-
-Subclasses:
-- @ref parse_error for exceptions indicating a parse error
-- @ref invalid_iterator for exceptions indicating errors with iterators
-- @ref type_error for exceptions indicating executing a member function with
- a wrong type
-- @ref out_of_range for exceptions indicating access out of the defined range
-- @ref other_error for exceptions indicating other library errors
-
-@internal
-@note To have nothrow-copy-constructible exceptions, we internally use
- `std::runtime_error` which can cope with arbitrary-length error messages.
- Intermediate strings are built with static functions and then passed to
- the actual constructor.
-@endinternal
-
-@liveexample{The following code shows how arbitrary library exceptions can be
-caught.,exception}
-
-@since version 3.0.0
-*/
+/// @brief general exception of the @ref basic_json class
+/// @sa https://json.nlohmann.me/api/basic_json/exception/
class exception : public std::exception
{
public:
@@ -2776,7 +2819,7 @@ class exception : public std::exception
protected:
JSON_HEDLEY_NON_NULL(3)
- exception(int id_, const char* what_arg) : id(id_), m(what_arg) {}
+ exception(int id_, const char* what_arg) : id(id_), m(what_arg) {} // NOLINT(bugprone-throw-keyword-missing)
static std::string name(const std::string& ename, int id_)
{
@@ -2852,51 +2895,8 @@ class exception : public std::exception
std::runtime_error m;
};
-/*!
-@brief exception indicating a parse error
-
-This exception is thrown by the library when a parse error occurs. Parse errors
-can occur during the deserialization of JSON text, CBOR, MessagePack, as well
-as when using JSON Patch.
-
-Member @a byte holds the byte index of the last read character in the input
-file.
-
-Exceptions have ids 1xx.
-
-name / id | example message | description
------------------------------- | --------------- | -------------------------
-json.exception.parse_error.101 | parse error at 2: unexpected end of input; expected string literal | This error indicates a syntax error while deserializing a JSON text. The error message describes that an unexpected token (character) was encountered, and the member @a byte indicates the error position.
-json.exception.parse_error.102 | parse error at 14: missing or wrong low surrogate | JSON uses the `\uxxxx` format to describe Unicode characters. Code points above above 0xFFFF are split into two `\uxxxx` entries ("surrogate pairs"). This error indicates that the surrogate pair is incomplete or contains an invalid code point.
-json.exception.parse_error.103 | parse error: code points above 0x10FFFF are invalid | Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are invalid.
-json.exception.parse_error.104 | parse error: JSON patch must be an array of objects | [RFC 6902](https://tools.ietf.org/html/rfc6902) requires a JSON Patch document to be a JSON document that represents an array of objects.
-json.exception.parse_error.105 | parse error: operation must have string member 'op' | An operation of a JSON Patch document must contain exactly one "op" member, whose value indicates the operation to perform. Its value must be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.
-json.exception.parse_error.106 | parse error: array index '01' must not begin with '0' | An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901)) may be `0` or any number without a leading `0`.
-json.exception.parse_error.107 | parse error: JSON pointer must be empty or begin with '/' - was: 'foo' | A JSON Pointer must be a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a `/` character.
-json.exception.parse_error.108 | parse error: escape character '~' must be followed with '0' or '1' | In a JSON Pointer, only `~0` and `~1` are valid escape sequences.
-json.exception.parse_error.109 | parse error: array index 'one' is not a number | A JSON Pointer array index must be a number.
-json.exception.parse_error.110 | parse error at 1: cannot read 2 bytes from vector | When parsing CBOR or MessagePack, the byte vector ends before the complete value has been read.
-json.exception.parse_error.112 | parse error at 1: error reading CBOR; last byte: 0xF8 | Not all types of CBOR or MessagePack are supported. This exception occurs if an unsupported byte was read.
-json.exception.parse_error.113 | parse error at 2: expected a CBOR string; last byte: 0x98 | While parsing a map key, a value that is not a string has been read.
-json.exception.parse_error.114 | parse error: Unsupported BSON record type 0x0F | The parsing of the corresponding BSON record type is not implemented (yet).
-json.exception.parse_error.115 | parse error at byte 5: syntax error while parsing UBJSON high-precision number: invalid number text: 1A | A UBJSON high-precision number could not be parsed.
-
-@note For an input with n bytes, 1 is the index of the first character and n+1
- is the index of the terminating null byte or the end of file. This also
- holds true when reading a byte vector (CBOR or MessagePack).
-
-@liveexample{The following code shows how a `parse_error` exception can be
-caught.,parse_error}
-
-@sa - @ref exception for the base class of the library exceptions
-@sa - @ref invalid_iterator for exceptions indicating errors with iterators
-@sa - @ref type_error for exceptions indicating executing a member function with
- a wrong type
-@sa - @ref out_of_range for exceptions indicating access out of the defined range
-@sa - @ref other_error for exceptions indicating other library errors
-
-@since version 3.0.0
-*/
+/// @brief exception indicating a parse error
+/// @sa https://json.nlohmann.me/api/basic_json/parse_error/
class parse_error : public exception
{
public:
@@ -2914,7 +2914,7 @@ class parse_error : public exception
{
std::string w = exception::name("parse_error", id_) + "parse error" +
position_string(pos) + ": " + exception::diagnostics(context) + what_arg;
- return parse_error(id_, pos.chars_read_total, w.c_str());
+ return {id_, pos.chars_read_total, w.c_str()};
}
template<typename BasicJsonType>
@@ -2923,7 +2923,7 @@ class parse_error : public exception
std::string w = exception::name("parse_error", id_) + "parse error" +
(byte_ != 0 ? (" at byte " + std::to_string(byte_)) : "") +
": " + exception::diagnostics(context) + what_arg;
- return parse_error(id_, byte_, w.c_str());
+ return {id_, byte_, w.c_str()};
}
/*!
@@ -2948,43 +2948,8 @@ class parse_error : public exception
}
};
-/*!
-@brief exception indicating errors with iterators
-
-This exception is thrown if iterators passed to a library function do not match
-the expected semantics.
-
-Exceptions have ids 2xx.
-
-name / id | example message | description
------------------------------------ | --------------- | -------------------------
-json.exception.invalid_iterator.201 | iterators are not compatible | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid.
-json.exception.invalid_iterator.202 | iterator does not fit current value | In an erase or insert function, the passed iterator @a pos does not belong to the JSON value for which the function was called. It hence does not define a valid position for the deletion/insertion.
-json.exception.invalid_iterator.203 | iterators do not fit current value | Either iterator passed to function @ref erase(IteratorType first, IteratorType last) does not belong to the JSON value from which values shall be erased. It hence does not define a valid range to delete values from.
-json.exception.invalid_iterator.204 | iterators out of range | When an iterator range for a primitive type (number, boolean, or string) is passed to a constructor or an erase function, this range has to be exactly (@ref begin(), @ref end()), because this is the only way the single stored value is expressed. All other ranges are invalid.
-json.exception.invalid_iterator.205 | iterator out of range | When an iterator for a primitive type (number, boolean, or string) is passed to an erase function, the iterator has to be the @ref begin() iterator, because it is the only way to address the stored value. All other iterators are invalid.
-json.exception.invalid_iterator.206 | cannot construct with iterators from null | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) belong to a JSON null value and hence to not define a valid range.
-json.exception.invalid_iterator.207 | cannot use key() for non-object iterators | The key() member function can only be used on iterators belonging to a JSON object, because other types do not have a concept of a key.
-json.exception.invalid_iterator.208 | cannot use operator[] for object iterators | The operator[] to specify a concrete offset cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
-json.exception.invalid_iterator.209 | cannot use offsets with object iterators | The offset operators (+, -, +=, -=) cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
-json.exception.invalid_iterator.210 | iterators do not fit | The iterator range passed to the insert function are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid.
-json.exception.invalid_iterator.211 | passed iterators may not belong to container | The iterator range passed to the insert function must not be a subrange of the container to insert to.
-json.exception.invalid_iterator.212 | cannot compare iterators of different containers | When two iterators are compared, they must belong to the same container.
-json.exception.invalid_iterator.213 | cannot compare order of object iterators | The order of object iterators cannot be compared, because JSON objects are unordered.
-json.exception.invalid_iterator.214 | cannot get value | Cannot get value for iterator: Either the iterator belongs to a null value or it is an iterator to a primitive type (number, boolean, or string), but the iterator is different to @ref begin().
-
-@liveexample{The following code shows how an `invalid_iterator` exception can be
-caught.,invalid_iterator}
-
-@sa - @ref exception for the base class of the library exceptions
-@sa - @ref parse_error for exceptions indicating a parse error
-@sa - @ref type_error for exceptions indicating executing a member function with
- a wrong type
-@sa - @ref out_of_range for exceptions indicating access out of the defined range
-@sa - @ref other_error for exceptions indicating other library errors
-
-@since version 3.0.0
-*/
+/// @brief exception indicating errors with iterators
+/// @sa https://json.nlohmann.me/api/basic_json/invalid_iterator/
class invalid_iterator : public exception
{
public:
@@ -2992,7 +2957,7 @@ class invalid_iterator : public exception
static invalid_iterator create(int id_, const std::string& what_arg, const BasicJsonType& context)
{
std::string w = exception::name("invalid_iterator", id_) + exception::diagnostics(context) + what_arg;
- return invalid_iterator(id_, w.c_str());
+ return {id_, w.c_str()};
}
private:
@@ -3001,45 +2966,8 @@ class invalid_iterator : public exception
: exception(id_, what_arg) {}
};
-/*!
-@brief exception indicating executing a member function with a wrong type
-
-This exception is thrown in case of a type error; that is, a library function is
-executed on a JSON value whose type does not match the expected semantics.
-
-Exceptions have ids 3xx.
-
-name / id | example message | description
------------------------------ | --------------- | -------------------------
-json.exception.type_error.301 | cannot create object from initializer list | To create an object from an initializer list, the initializer list must consist only of a list of pairs whose first element is a string. When this constraint is violated, an array is created instead.
-json.exception.type_error.302 | type must be object, but is array | During implicit or explicit value conversion, the JSON type must be compatible to the target type. For instance, a JSON string can only be converted into string types, but not into numbers or boolean types.
-json.exception.type_error.303 | incompatible ReferenceType for get_ref, actual type is object | To retrieve a reference to a value stored in a @ref basic_json object with @ref get_ref, the type of the reference must match the value type. For instance, for a JSON array, the @a ReferenceType must be @ref array_t &.
-json.exception.type_error.304 | cannot use at() with string | The @ref at() member functions can only be executed for certain JSON types.
-json.exception.type_error.305 | cannot use operator[] with string | The @ref operator[] member functions can only be executed for certain JSON types.
-json.exception.type_error.306 | cannot use value() with string | The @ref value() member functions can only be executed for certain JSON types.
-json.exception.type_error.307 | cannot use erase() with string | The @ref erase() member functions can only be executed for certain JSON types.
-json.exception.type_error.308 | cannot use push_back() with string | The @ref push_back() and @ref operator+= member functions can only be executed for certain JSON types.
-json.exception.type_error.309 | cannot use insert() with | The @ref insert() member functions can only be executed for certain JSON types.
-json.exception.type_error.310 | cannot use swap() with number | The @ref swap() member functions can only be executed for certain JSON types.
-json.exception.type_error.311 | cannot use emplace_back() with string | The @ref emplace_back() member function can only be executed for certain JSON types.
-json.exception.type_error.312 | cannot use update() with string | The @ref update() member functions can only be executed for certain JSON types.
-json.exception.type_error.313 | invalid value to unflatten | The @ref unflatten function converts an object whose keys are JSON Pointers back into an arbitrary nested JSON value. The JSON Pointers must not overlap, because then the resulting value would not be well defined.
-json.exception.type_error.314 | only objects can be unflattened | The @ref unflatten function only works for an object whose keys are JSON Pointers.
-json.exception.type_error.315 | values in object must be primitive | The @ref unflatten function only works for an object whose keys are JSON Pointers and whose values are primitive.
-json.exception.type_error.316 | invalid UTF-8 byte at index 10: 0x7E | The @ref dump 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. |
-json.exception.type_error.317 | JSON value cannot be serialized to requested format | The dynamic type of the object cannot be represented in the requested serialization format (e.g. a raw `true` or `null` JSON object cannot be serialized to BSON) |
-
-@liveexample{The following code shows how a `type_error` exception can be
-caught.,type_error}
-
-@sa - @ref exception for the base class of the library exceptions
-@sa - @ref parse_error for exceptions indicating a parse error
-@sa - @ref invalid_iterator for exceptions indicating errors with iterators
-@sa - @ref out_of_range for exceptions indicating access out of the defined range
-@sa - @ref other_error for exceptions indicating other library errors
-
-@since version 3.0.0
-*/
+/// @brief exception indicating executing a member function with a wrong type
+/// @sa https://json.nlohmann.me/api/basic_json/type_error/
class type_error : public exception
{
public:
@@ -3047,7 +2975,7 @@ class type_error : public exception
static type_error create(int id_, const std::string& what_arg, const BasicJsonType& context)
{
std::string w = exception::name("type_error", id_) + exception::diagnostics(context) + what_arg;
- return type_error(id_, w.c_str());
+ return {id_, w.c_str()};
}
private:
@@ -3055,39 +2983,8 @@ class type_error : public exception
type_error(int id_, const char* what_arg) : exception(id_, what_arg) {}
};
-/*!
-@brief exception indicating access out of the defined range
-
-This exception is thrown in case a library function is called on an input
-parameter that exceeds the expected range, for instance in case of array
-indices or nonexisting object keys.
-
-Exceptions have ids 4xx.
-
-name / id | example message | description
-------------------------------- | --------------- | -------------------------
-json.exception.out_of_range.401 | array index 3 is out of range | The provided array index @a i is larger than @a size-1.
-json.exception.out_of_range.402 | array index '-' (3) is out of range | The special array index `-` in a JSON Pointer never describes a valid element of the array, but the index past the end. That is, it can only be used to add elements at this position, but not to read it.
-json.exception.out_of_range.403 | key 'foo' not found | The provided key was not found in the JSON object.
-json.exception.out_of_range.404 | unresolved reference token 'foo' | A reference token in a JSON Pointer could not be resolved.
-json.exception.out_of_range.405 | JSON pointer has no parent | The JSON Patch operations 'remove' and 'add' can not be applied to the root element of the JSON value.
-json.exception.out_of_range.406 | number overflow parsing '10E1000' | A parsed number could not be stored as without changing it to NaN or INF.
-json.exception.out_of_range.407 | number overflow serializing '9223372036854775808' | UBJSON and BSON only support integer numbers up to 9223372036854775807. (until version 3.8.0) |
-json.exception.out_of_range.408 | excessive array size: 8658170730974374167 | The size (following `#`) of an UBJSON array or object exceeds the maximal capacity. |
-json.exception.out_of_range.409 | BSON key cannot contain code point U+0000 (at byte 2) | Key identifiers to be serialized to BSON cannot contain code point U+0000, since the key is stored as zero-terminated c-string |
-
-@liveexample{The following code shows how an `out_of_range` exception can be
-caught.,out_of_range}
-
-@sa - @ref exception for the base class of the library exceptions
-@sa - @ref parse_error for exceptions indicating a parse error
-@sa - @ref invalid_iterator for exceptions indicating errors with iterators
-@sa - @ref type_error for exceptions indicating executing a member function with
- a wrong type
-@sa - @ref other_error for exceptions indicating other library errors
-
-@since version 3.0.0
-*/
+/// @brief exception indicating access out of the defined range
+/// @sa https://json.nlohmann.me/api/basic_json/out_of_range/
class out_of_range : public exception
{
public:
@@ -3095,7 +2992,7 @@ class out_of_range : public exception
static out_of_range create(int id_, const std::string& what_arg, const BasicJsonType& context)
{
std::string w = exception::name("out_of_range", id_) + exception::diagnostics(context) + what_arg;
- return out_of_range(id_, w.c_str());
+ return {id_, w.c_str()};
}
private:
@@ -3103,30 +3000,8 @@ class out_of_range : public exception
out_of_range(int id_, const char* what_arg) : exception(id_, what_arg) {}
};
-/*!
-@brief exception indicating other library errors
-
-This exception is thrown in case of errors that cannot be classified with the
-other exception types.
-
-Exceptions have ids 5xx.
-
-name / id | example message | description
------------------------------- | --------------- | -------------------------
-json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed.
-
-@sa - @ref exception for the base class of the library exceptions
-@sa - @ref parse_error for exceptions indicating a parse error
-@sa - @ref invalid_iterator for exceptions indicating errors with iterators
-@sa - @ref type_error for exceptions indicating executing a member function with
- a wrong type
-@sa - @ref out_of_range for exceptions indicating access out of the defined range
-
-@liveexample{The following code shows how an `other_error` exception can be
-caught.,other_error}
-
-@since version 3.0.0
-*/
+/// @brief exception indicating other library errors
+/// @sa https://json.nlohmann.me/api/basic_json/other_error/
class other_error : public exception
{
public:
@@ -3134,13 +3009,14 @@ class other_error : public exception
static other_error create(int id_, const std::string& what_arg, const BasicJsonType& context)
{
std::string w = exception::name("other_error", id_) + exception::diagnostics(context) + what_arg;
- return other_error(id_, w.c_str());
+ return {id_, w.c_str()};
}
private:
JSON_HEDLEY_NON_NULL(3)
other_error(int id_, const char* what_arg) : exception(id_, what_arg) {}
};
+
} // namespace detail
} // namespace nlohmann
@@ -3298,7 +3174,7 @@ struct static_const
};
template<typename T>
-constexpr T static_const<T>::value;
+constexpr T static_const<T>::value; // NOLINT(readability-redundant-declaration)
} // namespace detail
} // namespace nlohmann
@@ -3434,6 +3310,8 @@ for serialization.
template<typename T = void, typename SFINAE = void>
struct adl_serializer;
+/// a class to store JSON values
+/// @sa https://json.nlohmann.me/api/basic_json/
template<template<typename U, typename V, typename... Args> class ObjectType =
std::map,
template<typename U, typename... Args> class ArrayType = std::vector,
@@ -3447,40 +3325,24 @@ template<template<typename U, typename V, typename... Args> class ObjectType =
class BinaryType = std::vector<std::uint8_t>>
class basic_json;
-/*!
-@brief JSON Pointer
-
-A JSON pointer defines a string syntax for identifying a specific value
-within a JSON document. It can be used with functions `at` and
-`operator[]`. Furthermore, JSON pointers are the base for JSON patches.
-
-@sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
-
-@since version 2.0.0
-*/
+/// @brief JSON Pointer defines a string syntax for identifying a specific value within a JSON document
+/// @sa https://json.nlohmann.me/api/json_pointer/
template<typename BasicJsonType>
class json_pointer;
/*!
-@brief default JSON class
-
-This type is the default specialization of the @ref basic_json class which
-uses the standard template types.
-
-@since version 1.0.0
+@brief default specialization
+@sa https://json.nlohmann.me/api/json/
*/
using json = basic_json<>;
+/// @brief a minimal map-like container that preserves insertion order
+/// @sa https://json.nlohmann.me/api/ordered_map/
template<class Key, class T, class IgnoredLess, class Allocator>
struct ordered_map;
-/*!
-@brief ordered JSON class
-
-This type preserves the insertion order of object keys.
-
-@since version 3.9.0
-*/
+/// @brief specialization that maintains the insertion order of object keys
+/// @sa https://json.nlohmann.me/api/ordered_json/
using ordered_json = basic_json<nlohmann::ordered_map>;
} // namespace nlohmann
@@ -3950,8 +3812,18 @@ T conditional_static_cast(U value)
// #include <nlohmann/detail/value_t.hpp>
-#ifdef JSON_HAS_CPP_17
- #include <filesystem>
+#if JSON_HAS_EXPERIMENTAL_FILESYSTEM
+#include <experimental/filesystem>
+namespace nlohmann::detail
+{
+namespace std_fs = std::experimental::filesystem;
+} // namespace nlohmann::detail
+#elif JSON_HAS_FILESYSTEM
+#include <filesystem>
+namespace nlohmann::detail
+{
+namespace std_fs = std::filesystem;
+} // namespace nlohmann::detail
#endif
namespace nlohmann
@@ -4379,9 +4251,9 @@ void from_json(const BasicJsonType& j, std::unordered_map<Key, Value, Hash, KeyE
}
}
-#ifdef JSON_HAS_CPP_17
+#if JSON_HAS_FILESYSTEM || JSON_HAS_EXPERIMENTAL_FILESYSTEM
template<typename BasicJsonType>
-void from_json(const BasicJsonType& j, std::filesystem::path& p)
+void from_json(const BasicJsonType& j, std_fs::path& p)
{
if (JSON_HEDLEY_UNLIKELY(!j.is_string()))
{
@@ -4626,8 +4498,18 @@ class tuple_element<N, ::nlohmann::detail::iteration_proxy_value<IteratorType >>
// #include <nlohmann/detail/value_t.hpp>
-#ifdef JSON_HAS_CPP_17
- #include <filesystem>
+#if JSON_HAS_EXPERIMENTAL_FILESYSTEM
+#include <experimental/filesystem>
+namespace nlohmann::detail
+{
+namespace std_fs = std::experimental::filesystem;
+} // namespace nlohmann::detail
+#elif JSON_HAS_FILESYSTEM
+#include <filesystem>
+namespace nlohmann::detail
+{
+namespace std_fs = std::filesystem;
+} // namespace nlohmann::detail
#endif
namespace nlohmann
@@ -5002,9 +4884,9 @@ void to_json(BasicJsonType& j, const T& t)
to_json_tuple_impl(j, t, make_index_sequence<std::tuple_size<T>::value> {});
}
-#ifdef JSON_HAS_CPP_17
+#if JSON_HAS_FILESYSTEM || JSON_HAS_EXPERIMENTAL_FILESYSTEM
template<typename BasicJsonType>
-void to_json(BasicJsonType& j, const std::filesystem::path& p)
+void to_json(BasicJsonType& j, const std_fs::path& p)
{
j = p.string();
}
@@ -5038,20 +4920,12 @@ constexpr const auto& to_json = detail::static_const<detail::to_json_fn>::value;
namespace nlohmann
{
+/// @sa https://json.nlohmann.me/api/adl_serializer/
template<typename ValueType, typename>
struct adl_serializer
{
- /*!
- @brief convert a JSON value to any value type
-
- This function is usually called by the `get()` function of the
- @ref basic_json class (either explicit or via conversion operators).
-
- @note This function is chosen for default-constructible value types.
-
- @param[in] j JSON value to read from
- @param[in,out] val value to write to
- */
+ /// @brief convert a JSON value to any value type
+ /// @sa https://json.nlohmann.me/api/adl_serializer/from_json/
template<typename BasicJsonType, typename TargetType = ValueType>
static auto from_json(BasicJsonType && j, TargetType& val) noexcept(
noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
@@ -5060,18 +4934,8 @@ struct adl_serializer
::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
}
- /*!
- @brief convert a JSON value to any value type
-
- This function is usually called by the `get()` function of the
- @ref basic_json class (either explicit or via conversion operators).
-
- @note This function is chosen for value types which are not default-constructible.
-
- @param[in] j JSON value to read from
-
- @return copy of the JSON value, converted to @a ValueType
- */
+ /// @brief convert a JSON value to any value type
+ /// @sa https://json.nlohmann.me/api/adl_serializer/from_json/
template<typename BasicJsonType, typename TargetType = ValueType>
static auto from_json(BasicJsonType && j) noexcept(
noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), detail::identity_tag<TargetType> {})))
@@ -5080,15 +4944,8 @@ struct adl_serializer
return ::nlohmann::from_json(std::forward<BasicJsonType>(j), detail::identity_tag<TargetType> {});
}
- /*!
- @brief convert any value type to a JSON value
-
- This function is usually called by the constructors of the @ref basic_json
- class.
-
- @param[in,out] j JSON value to write to
- @param[in] val value to read from
- */
+ /// @brief convert any value type to a JSON value
+ /// @sa https://json.nlohmann.me/api/adl_serializer/to_json/
template<typename BasicJsonType, typename TargetType = ValueType>
static auto to_json(BasicJsonType& j, TargetType && val) noexcept(
noexcept(::nlohmann::to_json(j, std::forward<TargetType>(val))))
@@ -5109,46 +4966,38 @@ struct adl_serializer
namespace nlohmann
{
-/*!
-@brief an internal type for a backed binary type
-
-This type extends the template parameter @a BinaryType provided to `basic_json`
-with a subtype used by BSON and MessagePack. This type exists so that the user
-does not have to specify a type themselves with a specific naming scheme in
-order to override the binary type.
-
-@tparam BinaryType container to store bytes (`std::vector<std::uint8_t>` by
- default)
-
-@since version 3.8.0; changed type of subtypes to std::uint64_t in 3.10.0.
-*/
+/// @brief an internal type for a backed binary type
+/// @sa https://json.nlohmann.me/api/byte_container_with_subtype/
template<typename BinaryType>
class byte_container_with_subtype : public BinaryType
{
public:
- /// the type of the underlying container
using container_type = BinaryType;
- /// the type of the subtype
using subtype_type = std::uint64_t;
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/byte_container_with_subtype/
byte_container_with_subtype() noexcept(noexcept(container_type()))
: container_type()
{}
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/byte_container_with_subtype/
byte_container_with_subtype(const container_type& b) noexcept(noexcept(container_type(b)))
: container_type(b)
{}
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/byte_container_with_subtype/
byte_container_with_subtype(container_type&& b) noexcept(noexcept(container_type(std::move(b))))
: container_type(std::move(b))
{}
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/byte_container_with_subtype/
byte_container_with_subtype(const container_type& b, subtype_type subtype_) noexcept(noexcept(container_type(b)))
: container_type(b)
, m_subtype(subtype_)
, m_has_subtype(true)
{}
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/byte_container_with_subtype/
byte_container_with_subtype(container_type&& b, subtype_type subtype_) noexcept(noexcept(container_type(std::move(b))))
: container_type(std::move(b))
, m_subtype(subtype_)
@@ -5166,97 +5015,30 @@ class byte_container_with_subtype : public BinaryType
return !(rhs == *this);
}
- /*!
- @brief sets the binary subtype
-
- Sets the binary subtype of the value, also flags a binary JSON value as
- having a subtype, which has implications for serialization.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @sa see @ref subtype() -- return the binary subtype
- @sa see @ref clear_subtype() -- clears the binary subtype
- @sa see @ref has_subtype() -- returns whether or not the binary value has a
- subtype
-
- @since version 3.8.0
- */
+ /// @brief sets the binary subtype
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/set_subtype/
void set_subtype(subtype_type subtype_) noexcept
{
m_subtype = subtype_;
m_has_subtype = true;
}
- /*!
- @brief return the binary subtype
-
- Returns the numerical subtype of the value if it has a subtype. If it does
- not have a subtype, this function will return subtype_type(-1) as a sentinel
- value.
-
- @return the numerical subtype of the binary value
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @sa see @ref set_subtype() -- sets the binary subtype
- @sa see @ref clear_subtype() -- clears the binary subtype
- @sa see @ref has_subtype() -- returns whether or not the binary value has a
- subtype
-
- @since version 3.8.0; fixed return value to properly return
- subtype_type(-1) as documented in version 3.10.0
- */
+ /// @brief return the binary subtype
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/subtype/
constexpr subtype_type subtype() const noexcept
{
- return m_has_subtype ? m_subtype : subtype_type(-1);
+ return m_has_subtype ? m_subtype : static_cast<subtype_type>(-1);
}
- /*!
- @brief return whether the value has a subtype
-
- @return whether the value has a subtype
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @sa see @ref subtype() -- return the binary subtype
- @sa see @ref set_subtype() -- sets the binary subtype
- @sa see @ref clear_subtype() -- clears the binary subtype
-
- @since version 3.8.0
- */
+ /// @brief return whether the value has a subtype
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/has_subtype/
constexpr bool has_subtype() const noexcept
{
return m_has_subtype;
}
- /*!
- @brief clears the binary subtype
-
- Clears the binary subtype and flags the value as not having a subtype, which
- has implications for serialization; for instance MessagePack will prefer the
- bin family over the ext family.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @sa see @ref subtype() -- return the binary subtype
- @sa see @ref set_subtype() -- sets the binary subtype
- @sa see @ref has_subtype() -- returns whether or not the binary value has a
- subtype
-
- @since version 3.8.0
- */
+ /// @brief clears the binary subtype
+ /// @sa https://json.nlohmann.me/api/byte_container_with_subtype/clear_subtype/
void clear_subtype() noexcept
{
m_subtype = 0;
@@ -5529,7 +5311,7 @@ class input_stream_adapter
// std::istream/std::streambuf use std::char_traits<char>::to_int_type, to
// ensure that std::char_traits<char>::eof() and the character 0xFF do not
- // end up as the same value, eg. 0xFFFFFFFF.
+ // end up as the same value, e.g. 0xFFFFFFFF.
std::char_traits<char>::int_type get_character()
{
auto res = sb->sbumpc();
@@ -5875,7 +5657,7 @@ auto input_adapter(T (&array)[N]) -> decltype(input_adapter(array, array + N)) /
}
// This class only handles inputs of input_buffer_adapter type.
-// It's required so that expressions like {ptr, len} can be implicitely casted
+// It's required so that expressions like {ptr, len} can be implicitly cast
// to the correct adapter.
class span_input_adapter
{
@@ -5968,7 +5750,7 @@ struct json_sax
virtual bool number_unsigned(number_unsigned_t val) = 0;
/*!
- @brief an floating-point number was read
+ @brief a floating-point number was read
@param[in] val floating-point value
@param[in] s raw token value
@return whether parsing should proceed
@@ -5976,18 +5758,18 @@ struct json_sax
virtual bool number_float(number_float_t val, const string_t& s) = 0;
/*!
- @brief a string was read
+ @brief a string value was read
@param[in] val string value
@return whether parsing should proceed
- @note It is safe to move the passed string.
+ @note It is safe to move the passed string value.
*/
virtual bool string(string_t& val) = 0;
/*!
- @brief a binary string was read
+ @brief a binary value was read
@param[in] val binary value
@return whether parsing should proceed
- @note It is safe to move the passed binary.
+ @note It is safe to move the passed binary value.
*/
virtual bool binary(binary_t& val) = 0;
@@ -6134,7 +5916,7 @@ class json_sax_dom_parser
{
ref_stack.push_back(handle_value(BasicJsonType::value_t::object));
- if (JSON_HEDLEY_UNLIKELY(len != std::size_t(-1) && len > ref_stack.back()->max_size()))
+ if (JSON_HEDLEY_UNLIKELY(len != static_cast<std::size_t>(-1) && len > ref_stack.back()->max_size()))
{
JSON_THROW(out_of_range::create(408, "excessive object size: " + std::to_string(len), *ref_stack.back()));
}
@@ -6160,7 +5942,7 @@ class json_sax_dom_parser
{
ref_stack.push_back(handle_value(BasicJsonType::value_t::array));
- if (JSON_HEDLEY_UNLIKELY(len != std::size_t(-1) && len > ref_stack.back()->max_size()))
+ if (JSON_HEDLEY_UNLIKELY(len != static_cast<std::size_t>(-1) && len > ref_stack.back()->max_size()))
{
JSON_THROW(out_of_range::create(408, "excessive array size: " + std::to_string(len), *ref_stack.back()));
}
@@ -6315,7 +6097,7 @@ class json_sax_dom_callback_parser
ref_stack.push_back(val.second);
// check object limit
- if (ref_stack.back() && JSON_HEDLEY_UNLIKELY(len != std::size_t(-1) && len > ref_stack.back()->max_size()))
+ if (ref_stack.back() && JSON_HEDLEY_UNLIKELY(len != static_cast<std::size_t>(-1) && len > ref_stack.back()->max_size()))
{
JSON_THROW(out_of_range::create(408, "excessive object size: " + std::to_string(len), *ref_stack.back()));
}
@@ -6385,7 +6167,7 @@ class json_sax_dom_callback_parser
ref_stack.push_back(val.second);
// check array limit
- if (ref_stack.back() && JSON_HEDLEY_UNLIKELY(len != std::size_t(-1) && len > ref_stack.back()->max_size()))
+ if (ref_stack.back() && JSON_HEDLEY_UNLIKELY(len != static_cast<std::size_t>(-1) && len > ref_stack.back()->max_size()))
{
JSON_THROW(out_of_range::create(408, "excessive array size: " + std::to_string(len), *ref_stack.back()));
}
@@ -6588,7 +6370,7 @@ class json_sax_acceptor
return true;
}
- bool start_object(std::size_t /*unused*/ = std::size_t(-1))
+ bool start_object(std::size_t /*unused*/ = static_cast<std::size_t>(-1))
{
return true;
}
@@ -6603,7 +6385,7 @@ class json_sax_acceptor
return true;
}
- bool start_array(std::size_t /*unused*/ = std::size_t(-1))
+ bool start_array(std::size_t /*unused*/ = static_cast<std::size_t>(-1))
{
return true;
}
@@ -6971,7 +6753,7 @@ class lexer : public lexer_base<BasicJsonType>
// low surrogate occupies the least significant 15 bits
+ static_cast<unsigned int>(codepoint2)
// there is still the 0xD800, 0xDC00 and 0x10000 noise
- // in the result so we have to subtract with:
+ // in the result, so we have to subtract with:
// (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00
- 0x35FDC00u);
}
@@ -8075,7 +7857,7 @@ scan_number_done:
{
// escape control characters
std::array<char, 9> cs{{}};
- (std::snprintf)(cs.data(), cs.size(), "<U+%.4X>", static_cast<unsigned char>(c)); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
+ static_cast<void>((std::snprintf)(cs.data(), cs.size(), "<U+%.4X>", static_cast<unsigned char>(c))); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
result += cs.data();
}
else
@@ -8169,17 +7951,17 @@ scan_number_done:
// literals
case 't':
{
- std::array<char_type, 4> true_literal = {{char_type('t'), char_type('r'), char_type('u'), char_type('e')}};
+ std::array<char_type, 4> true_literal = {{static_cast<char_type>('t'), static_cast<char_type>('r'), static_cast<char_type>('u'), static_cast<char_type>('e')}};
return scan_literal(true_literal.data(), true_literal.size(), token_type::literal_true);
}
case 'f':
{
- std::array<char_type, 5> false_literal = {{char_type('f'), char_type('a'), char_type('l'), char_type('s'), char_type('e')}};
+ std::array<char_type, 5> false_literal = {{static_cast<char_type>('f'), static_cast<char_type>('a'), static_cast<char_type>('l'), static_cast<char_type>('s'), static_cast<char_type>('e')}};
return scan_literal(false_literal.data(), false_literal.size(), token_type::literal_false);
}
case 'n':
{
- std::array<char_type, 4> null_literal = {{char_type('n'), char_type('u'), char_type('l'), char_type('l')}};
+ std::array<char_type, 4> null_literal = {{static_cast<char_type>('n'), static_cast<char_type>('u'), static_cast<char_type>('l'), static_cast<char_type>('l')}};
return scan_literal(null_literal.data(), null_literal.size(), token_type::literal_null);
}
@@ -8430,7 +8212,7 @@ enum class cbor_tag_handler_t
@note from https://stackoverflow.com/a/1001328/266378
*/
-static inline bool little_endianess(int num = 1) noexcept
+static inline bool little_endianness(int num = 1) noexcept
{
return *reinterpret_cast<char*>(&num) == 1;
}
@@ -8549,7 +8331,7 @@ class binary_reader
std::int32_t document_size{};
get_number<std::int32_t, true>(input_format_t::bson, document_size);
- if (JSON_HEDLEY_UNLIKELY(!sax->start_object(std::size_t(-1))))
+ if (JSON_HEDLEY_UNLIKELY(!sax->start_object(static_cast<std::size_t>(-1))))
{
return false;
}
@@ -8706,7 +8488,7 @@ class binary_reader
default: // anything else not supported (yet)
{
std::array<char, 3> cr{{}};
- (std::snprintf)(cr.data(), cr.size(), "%.2hhX", static_cast<unsigned char>(element_type)); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
+ static_cast<void>((std::snprintf)(cr.data(), cr.size(), "%.2hhX", static_cast<unsigned char>(element_type))); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
return sax->parse_error(element_type_parse_position, std::string(cr.data()), parse_error::create(114, element_type_parse_position, "Unsupported BSON record type 0x" + std::string(cr.data()), BasicJsonType()));
}
}
@@ -8767,7 +8549,7 @@ class binary_reader
std::int32_t document_size{};
get_number<std::int32_t, true>(input_format_t::bson, document_size);
- if (JSON_HEDLEY_UNLIKELY(!sax->start_array(std::size_t(-1))))
+ if (JSON_HEDLEY_UNLIKELY(!sax->start_array(static_cast<std::size_t>(-1))))
{
return false;
}
@@ -9026,7 +8808,7 @@ class binary_reader
}
case 0x9F: // array (indefinite length)
- return get_cbor_array(std::size_t(-1), tag_handler);
+ return get_cbor_array(static_cast<std::size_t>(-1), tag_handler);
// map (0x00..0x17 pairs of data items follow)
case 0xA0:
@@ -9080,7 +8862,7 @@ class binary_reader
}
case 0xBF: // map (indefinite length)
- return get_cbor_object(std::size_t(-1), tag_handler);
+ return get_cbor_object(static_cast<std::size_t>(-1), tag_handler);
case 0xC6: // tagged item
case 0xC7:
@@ -9464,7 +9246,7 @@ class binary_reader
}
/*!
- @param[in] len the length of the array or std::size_t(-1) for an
+ @param[in] len the length of the array or static_cast<std::size_t>(-1) for an
array of indefinite size
@param[in] tag_handler how CBOR tags should be treated
@return whether array creation completed
@@ -9477,7 +9259,7 @@ class binary_reader
return false;
}
- if (len != std::size_t(-1))
+ if (len != static_cast<std::size_t>(-1))
{
for (std::size_t i = 0; i < len; ++i)
{
@@ -9502,7 +9284,7 @@ class binary_reader
}
/*!
- @param[in] len the length of the object or std::size_t(-1) for an
+ @param[in] len the length of the object or static_cast<std::size_t>(-1) for an
object of indefinite size
@param[in] tag_handler how CBOR tags should be treated
@return whether object creation completed
@@ -9518,7 +9300,7 @@ class binary_reader
if (len != 0)
{
string_t key;
- if (len != std::size_t(-1))
+ if (len != static_cast<std::size_t>(-1))
{
for (std::size_t i = 0; i < len; ++i)
{
@@ -10528,7 +10310,7 @@ class binary_reader
}
else
{
- if (JSON_HEDLEY_UNLIKELY(!sax->start_array(std::size_t(-1))))
+ if (JSON_HEDLEY_UNLIKELY(!sax->start_array(static_cast<std::size_t>(-1))))
{
return false;
}
@@ -10598,7 +10380,7 @@ class binary_reader
}
else
{
- if (JSON_HEDLEY_UNLIKELY(!sax->start_object(std::size_t(-1))))
+ if (JSON_HEDLEY_UNLIKELY(!sax->start_object(static_cast<std::size_t>(-1))))
{
return false;
}
@@ -10729,7 +10511,7 @@ class binary_reader
@return whether conversion completed
- @note This function needs to respect the system's endianess, because
+ @note This function needs to respect the system's endianness, because
bytes in CBOR, MessagePack, and UBJSON are stored in network order
(big endian) and therefore need reordering on little endian systems.
*/
@@ -10850,7 +10632,7 @@ class binary_reader
std::string get_token_string() const
{
std::array<char, 3> cr{{}};
- (std::snprintf)(cr.data(), cr.size(), "%.2hhX", static_cast<unsigned char>(current)); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
+ static_cast<void>((std::snprintf)(cr.data(), cr.size(), "%.2hhX", static_cast<unsigned char>(current))); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
return std::string{cr.data()};
}
@@ -10902,8 +10684,8 @@ class binary_reader
/// the number of characters read
std::size_t chars_read = 0;
- /// whether we can assume little endianess
- const bool is_little_endian = little_endianess();
+ /// whether we can assume little endianness
+ const bool is_little_endian = little_endianness();
/// the SAX parser
json_sax_t* sax = nullptr;
@@ -11111,7 +10893,7 @@ class parser
{
case token_type::begin_object:
{
- if (JSON_HEDLEY_UNLIKELY(!sax->start_object(std::size_t(-1))))
+ if (JSON_HEDLEY_UNLIKELY(!sax->start_object(static_cast<std::size_t>(-1))))
{
return false;
}
@@ -11156,7 +10938,7 @@ class parser
case token_type::begin_array:
{
- if (JSON_HEDLEY_UNLIKELY(!sax->start_array(std::size_t(-1))))
+ if (JSON_HEDLEY_UNLIKELY(!sax->start_array(static_cast<std::size_t>(-1))))
{
return false;
}
@@ -11621,7 +11403,7 @@ This class implements a both iterators (iterator and const_iterator) for the
iterators in version 3.0.0 (see https://github.com/nlohmann/json/issues/593)
*/
template<typename BasicJsonType>
-class iter_impl
+class iter_impl // NOLINT(cppcoreguidelines-special-member-functions,hicpp-special-member-functions)
{
/// the iterator with BasicJsonType of different const-ness
using other_iter_impl = iter_impl<typename std::conditional<std::is_const<BasicJsonType>::value, typename std::remove_const<BasicJsonType>::type, const BasicJsonType>::type>;
@@ -12470,6 +12252,9 @@ class json_reverse_iterator : public std::reverse_iterator<Base>
namespace nlohmann
{
+
+/// @brief JSON Pointer defines a string syntax for identifying a specific value within a JSON document
+/// @sa https://json.nlohmann.me/api/json_pointer/
template<typename BasicJsonType>
class json_pointer
{
@@ -12478,45 +12263,14 @@ class json_pointer
friend class basic_json;
public:
- /*!
- @brief create JSON pointer
-
- Create a JSON pointer according to the syntax described in
- [Section 3 of RFC6901](https://tools.ietf.org/html/rfc6901#section-3).
-
- @param[in] s string representing the JSON pointer; if omitted, the empty
- string is assumed which references the whole JSON value
-
- @throw parse_error.107 if the given JSON pointer @a s is nonempty and does
- not begin with a slash (`/`); see example below
-
- @throw parse_error.108 if a tilde (`~`) in the given JSON pointer @a s is
- not followed by `0` (representing `~`) or `1` (representing `/`); see
- example below
-
- @liveexample{The example shows the construction several valid JSON pointers
- as well as the exceptional behavior.,json_pointer}
-
- @since version 2.0.0
- */
+ /// @brief create JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/json_pointer/
explicit json_pointer(const std::string& s = "")
: reference_tokens(split(s))
{}
- /*!
- @brief return a string representation of the JSON pointer
-
- @invariant For each JSON pointer `ptr`, it holds:
- @code {.cpp}
- ptr == json_pointer(ptr.to_string());
- @endcode
-
- @return a string representation of the JSON pointer
-
- @liveexample{The example shows the result of `to_string`.,json_pointer__to_string}
-
- @since version 2.0.0
- */
+ /// @brief return a string representation of the JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/to_string/
std::string to_string() const
{
return std::accumulate(reference_tokens.begin(), reference_tokens.end(),
@@ -12527,28 +12281,15 @@ class json_pointer
});
}
- /// @copydoc to_string()
+ /// @brief return a string representation of the JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/operator_string/
operator std::string() const
{
return to_string();
}
- /*!
- @brief append another JSON pointer at the end of this JSON pointer
-
- @param[in] ptr JSON pointer to append
- @return JSON pointer with @a ptr appended
-
- @liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
-
- @complexity Linear in the length of @a ptr.
-
- @sa see @ref operator/=(std::string) to append a reference token
- @sa see @ref operator/=(std::size_t) to append an array index
- @sa see @ref operator/(const json_pointer&, const json_pointer&) for a binary operator
-
- @since version 3.6.0
- */
+ /// @brief append another JSON pointer at the end of this JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/operator_slasheq/
json_pointer& operator/=(const json_pointer& ptr)
{
reference_tokens.insert(reference_tokens.end(),
@@ -12557,123 +12298,45 @@ class json_pointer
return *this;
}
- /*!
- @brief append an unescaped reference token at the end of this JSON pointer
-
- @param[in] token reference token to append
- @return JSON pointer with @a token appended without escaping @a token
-
- @liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
-
- @complexity Amortized constant.
-
- @sa see @ref operator/=(const json_pointer&) to append a JSON pointer
- @sa see @ref operator/=(std::size_t) to append an array index
- @sa see @ref operator/(const json_pointer&, std::size_t) for a binary operator
-
- @since version 3.6.0
- */
+ /// @brief append an unescaped reference token at the end of this JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/operator_slasheq/
json_pointer& operator/=(std::string token)
{
push_back(std::move(token));
return *this;
}
- /*!
- @brief append an array index at the end of this JSON pointer
-
- @param[in] array_idx array index to append
- @return JSON pointer with @a array_idx appended
-
- @liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
-
- @complexity Amortized constant.
-
- @sa see @ref operator/=(const json_pointer&) to append a JSON pointer
- @sa see @ref operator/=(std::string) to append a reference token
- @sa see @ref operator/(const json_pointer&, std::string) for a binary operator
-
- @since version 3.6.0
- */
+ /// @brief append an array index at the end of this JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/operator_slasheq/
json_pointer& operator/=(std::size_t array_idx)
{
return *this /= std::to_string(array_idx);
}
- /*!
- @brief create a new JSON pointer by appending the right JSON pointer at the end of the left JSON pointer
-
- @param[in] lhs JSON pointer
- @param[in] rhs JSON pointer
- @return a new JSON pointer with @a rhs appended to @a lhs
-
- @liveexample{The example shows the usage of `operator/`.,json_pointer__operator_add_binary}
-
- @complexity Linear in the length of @a lhs and @a rhs.
-
- @sa see @ref operator/=(const json_pointer&) to append a JSON pointer
-
- @since version 3.6.0
- */
+ /// @brief create a new JSON pointer by appending the right JSON pointer at the end of the left JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/operator_slash/
friend json_pointer operator/(const json_pointer& lhs,
const json_pointer& rhs)
{
return json_pointer(lhs) /= rhs;
}
- /*!
- @brief create a new JSON pointer by appending the unescaped token at the end of the JSON pointer
-
- @param[in] ptr JSON pointer
- @param[in] token reference token
- @return a new JSON pointer with unescaped @a token appended to @a ptr
-
- @liveexample{The example shows the usage of `operator/`.,json_pointer__operator_add_binary}
-
- @complexity Linear in the length of @a ptr.
-
- @sa see @ref operator/=(std::string) to append a reference token
-
- @since version 3.6.0
- */
- friend json_pointer operator/(const json_pointer& ptr, std::string token) // NOLINT(performance-unnecessary-value-param)
+ /// @brief create a new JSON pointer by appending the unescaped token at the end of the JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/operator_slash/
+ friend json_pointer operator/(const json_pointer& lhs, std::string token) // NOLINT(performance-unnecessary-value-param)
{
- return json_pointer(ptr) /= std::move(token);
+ return json_pointer(lhs) /= std::move(token);
}
- /*!
- @brief create a new JSON pointer by appending the array-index-token at the end of the JSON pointer
-
- @param[in] ptr JSON pointer
- @param[in] array_idx array index
- @return a new JSON pointer with @a array_idx appended to @a ptr
-
- @liveexample{The example shows the usage of `operator/`.,json_pointer__operator_add_binary}
-
- @complexity Linear in the length of @a ptr.
-
- @sa see @ref operator/=(std::size_t) to append an array index
-
- @since version 3.6.0
- */
- friend json_pointer operator/(const json_pointer& ptr, std::size_t array_idx)
+ /// @brief create a new JSON pointer by appending the array-index-token at the end of the JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/operator_slash/
+ friend json_pointer operator/(const json_pointer& lhs, std::size_t array_idx)
{
- return json_pointer(ptr) /= array_idx;
+ return json_pointer(lhs) /= array_idx;
}
- /*!
- @brief returns the parent of this JSON pointer
-
- @return parent of this JSON pointer; in case this JSON pointer is the root,
- the root itself is returned
-
- @complexity Linear in the length of the JSON pointer.
-
- @liveexample{The example shows the result of `parent_pointer` for different
- JSON Pointers.,json_pointer__parent_pointer}
-
- @since version 3.6.0
- */
+ /// @brief returns the parent of this JSON pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/parent_pointer/
json_pointer parent_pointer() const
{
if (empty())
@@ -12686,19 +12349,8 @@ class json_pointer
return res;
}
- /*!
- @brief remove last reference token
-
- @pre not `empty()`
-
- @liveexample{The example shows the usage of `pop_back`.,json_pointer__pop_back}
-
- @complexity Constant.
-
- @throw out_of_range.405 if JSON pointer has no parent
-
- @since version 3.6.0
- */
+ /// @brief remove last reference token
+ /// @sa https://json.nlohmann.me/api/json_pointer/pop_back/
void pop_back()
{
if (JSON_HEDLEY_UNLIKELY(empty()))
@@ -12709,20 +12361,8 @@ class json_pointer
reference_tokens.pop_back();
}
- /*!
- @brief return last reference token
-
- @pre not `empty()`
- @return last reference token
-
- @liveexample{The example shows the usage of `back`.,json_pointer__back}
-
- @complexity Constant.
-
- @throw out_of_range.405 if JSON pointer has no parent
-
- @since version 3.6.0
- */
+ /// @brief return last reference token
+ /// @sa https://json.nlohmann.me/api/json_pointer/back/
const std::string& back() const
{
if (JSON_HEDLEY_UNLIKELY(empty()))
@@ -12733,43 +12373,22 @@ class json_pointer
return reference_tokens.back();
}
- /*!
- @brief append an unescaped token at the end of the reference pointer
-
- @param[in] token token to add
-
- @complexity Amortized constant.
-
- @liveexample{The example shows the result of `push_back` for different
- JSON Pointers.,json_pointer__push_back}
-
- @since version 3.6.0
- */
+ /// @brief append an unescaped token at the end of the reference pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/push_back/
void push_back(const std::string& token)
{
reference_tokens.push_back(token);
}
- /// @copydoc push_back(const std::string&)
+ /// @brief append an unescaped token at the end of the reference pointer
+ /// @sa https://json.nlohmann.me/api/json_pointer/push_back/
void push_back(std::string&& token)
{
reference_tokens.push_back(std::move(token));
}
- /*!
- @brief return whether pointer points to the root document
-
- @return true iff the JSON pointer points to the root document
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @liveexample{The example shows the result of `empty` for different JSON
- Pointers.,json_pointer__empty}
-
- @since version 3.6.0
- */
+ /// @brief return whether pointer points to the root document
+ /// @sa https://json.nlohmann.me/api/json_pointer/empty/
bool empty() const noexcept
{
return reference_tokens.empty();
@@ -14750,7 +14369,7 @@ class binary_writer
{
std::size_t array_index = 0ul;
- const std::size_t embedded_document_size = std::accumulate(std::begin(value), std::end(value), std::size_t(0), [&array_index](std::size_t result, const typename BasicJsonType::array_t::value_type & el)
+ const std::size_t embedded_document_size = std::accumulate(std::begin(value), std::end(value), static_cast<std::size_t>(0), [&array_index](std::size_t result, const typename BasicJsonType::array_t::value_type & el)
{
return result + calc_bson_element_size(std::to_string(array_index++), el);
});
@@ -14794,7 +14413,7 @@ class binary_writer
write_bson_entry_header(name, 0x05);
write_number<std::int32_t, true>(static_cast<std::int32_t>(value.size()));
- write_number(value.has_subtype() ? static_cast<std::uint8_t>(value.subtype()) : std::uint8_t(0x00));
+ write_number(value.has_subtype() ? static_cast<std::uint8_t>(value.subtype()) : static_cast<std::uint8_t>(0x00));
oa->write_characters(reinterpret_cast<const CharType*>(value.data()), value.size());
}
@@ -14900,7 +14519,7 @@ class binary_writer
*/
static std::size_t calc_bson_object_size(const typename BasicJsonType::object_t& value)
{
- std::size_t document_size = std::accumulate(value.begin(), value.end(), std::size_t(0),
+ std::size_t document_size = std::accumulate(value.begin(), value.end(), static_cast<std::size_t>(0),
[](size_t result, const typename BasicJsonType::object_t::value_type & el)
{
return result += calc_bson_element_size(el.first, el.second);
@@ -15202,7 +14821,7 @@ class binary_writer
@tparam OutputIsLittleEndian Set to true if output data is
required to be little endian
- @note This function needs to respect the system's endianess, because bytes
+ @note This function needs to respect the system's endianness, because bytes
in CBOR, MessagePack, and UBJSON are stored in network order (big
endian) and therefore need reordering on little endian systems.
*/
@@ -15292,8 +14911,8 @@ class binary_writer
}
private:
- /// whether we can assume little endianess
- const bool is_little_endian = little_endianess();
+ /// whether we can assume little endianness
+ const bool is_little_endian = little_endianness();
/// the output
output_adapter_t<CharType> oa = nullptr;
@@ -15315,6 +14934,8 @@ class binary_writer
#include <cstdio> // snprintf
#include <limits> // numeric_limits
#include <string> // string, char_traits
+#include <iomanip> // setfill, setw
+#include <sstream> // stringstream
#include <type_traits> // is_same
#include <utility> // move
@@ -16213,7 +15834,7 @@ void grisu2(char* buf, int& len, int& decimal_exponent, FloatType value)
//
// The documentation for 'std::to_chars' (https://en.cppreference.com/w/cpp/utility/to_chars)
// says "value is converted to a string as if by std::sprintf in the default ("C") locale"
- // and since sprintf promotes float's to double's, I think this is exactly what 'std::to_chars'
+ // and since sprintf promotes floats to doubles, I think this is exactly what 'std::to_chars'
// does.
// On the other hand, the documentation for 'std::to_chars' requires that "parsing the
// representation using the corresponding std::from_chars function recovers value exactly". That
@@ -16879,16 +16500,16 @@ class serializer
if (codepoint <= 0xFFFF)
{
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
- (std::snprintf)(string_buffer.data() + bytes, 7, "\\u%04x",
- static_cast<std::uint16_t>(codepoint));
+ static_cast<void>((std::snprintf)(string_buffer.data() + bytes, 7, "\\u%04x",
+ static_cast<std::uint16_t>(codepoint)));
bytes += 6;
}
else
{
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
- (std::snprintf)(string_buffer.data() + bytes, 13, "\\u%04x\\u%04x",
- static_cast<std::uint16_t>(0xD7C0u + (codepoint >> 10u)),
- static_cast<std::uint16_t>(0xDC00u + (codepoint & 0x3FFu)));
+ static_cast<void>((std::snprintf)(string_buffer.data() + bytes, 13, "\\u%04x\\u%04x",
+ static_cast<std::uint16_t>(0xD7C0u + (codepoint >> 10u)),
+ static_cast<std::uint16_t>(0xDC00u + (codepoint & 0x3FFu))));
bytes += 12;
}
}
@@ -16923,10 +16544,9 @@ class serializer
{
case error_handler_t::strict:
{
- std::string sn(9, '\0');
- // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
- (std::snprintf)(&sn[0], sn.size(), "%.2X", byte);
- JSON_THROW(type_error::create(316, "invalid UTF-8 byte at index " + std::to_string(i) + ": 0x" + sn, BasicJsonType()));
+ std::stringstream ss;
+ ss << std::uppercase << std::setfill('0') << std::setw(2) << std::hex << (byte | 0);
+ JSON_THROW(type_error::create(316, "invalid UTF-8 byte at index " + std::to_string(i) + ": 0x" + ss.str(), BasicJsonType()));
}
case error_handler_t::ignore:
@@ -17018,10 +16638,9 @@ class serializer
{
case error_handler_t::strict:
{
- std::string sn(9, '\0');
- // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
- (std::snprintf)(&sn[0], sn.size(), "%.2X", static_cast<std::uint8_t>(s.back()));
- JSON_THROW(type_error::create(316, "incomplete UTF-8 string; last byte: 0x" + sn, BasicJsonType()));
+ std::stringstream ss;
+ ss << std::uppercase << std::setfill('0') << std::setw(2) << std::hex << (static_cast<std::uint8_t>(s.back()) | 0);
+ JSON_THROW(type_error::create(316, "incomplete UTF-8 string; last byte: 0x" + ss.str(), BasicJsonType()));
}
case error_handler_t::ignore:
@@ -17088,6 +16707,19 @@ class serializer
}
}
+ // templates to avoid warnings about useless casts
+ template <typename NumberType, enable_if_t<std::is_signed<NumberType>::value, int> = 0>
+ bool is_negative_number(NumberType x)
+ {
+ return x < 0;
+ }
+
+ template < typename NumberType, enable_if_t <std::is_unsigned<NumberType>::value, int > = 0 >
+ bool is_negative_number(NumberType /*unused*/)
+ {
+ return false;
+ }
+
/*!
@brief dump an integer
@@ -17131,12 +16763,11 @@ class serializer
// use a pointer to fill the buffer
auto buffer_ptr = number_buffer.begin(); // NOLINT(llvm-qualified-auto,readability-qualified-auto,cppcoreguidelines-pro-type-vararg,hicpp-vararg)
- const bool is_negative = std::is_signed<NumberType>::value && !(x >= 0); // see issue #755
number_unsigned_t abs_value;
unsigned int n_chars{};
- if (is_negative)
+ if (is_negative_number(x))
{
*buffer_ptr = '-';
abs_value = remove_sign(static_cast<number_integer_t>(x));
@@ -17153,7 +16784,7 @@ class serializer
// spare 1 byte for '\0'
JSON_ASSERT(n_chars < number_buffer.size() - 1);
- // jump to the end to generate the string from backward
+ // jump to the end to generate the string from backward,
// so we later avoid reversing the result
buffer_ptr += n_chars;
@@ -17255,7 +16886,7 @@ class serializer
o->write_characters(number_buffer.data(), static_cast<std::size_t>(len));
- // determine if need to append ".0"
+ // determine if we need to append ".0"
const bool value_is_int_like =
std::none_of(number_buffer.begin(), number_buffer.begin() + len + 1,
[](char c)
@@ -17410,10 +17041,10 @@ template <class Key, class T, class IgnoredLess = std::less<Key>,
using key_type = Key;
using mapped_type = T;
using Container = std::vector<std::pair<const Key, T>, Allocator>;
- using typename Container::iterator;
- using typename Container::const_iterator;
- using typename Container::size_type;
- using typename Container::value_type;
+ using iterator = typename Container::iterator;
+ using const_iterator = typename Container::const_iterator;
+ using size_type = typename Container::size_type;
+ using value_type = typename Container::value_type;
// Explicit constructors instead of `using Container::Container`
// otherwise older compilers choke on it (GCC <= 5.5, xcode <= 9.4)
@@ -17494,16 +17125,55 @@ template <class Key, class T, class IgnoredLess = std::less<Key>,
iterator erase(iterator pos)
{
- auto it = pos;
+ return erase(pos, std::next(pos));
+ }
+
+ iterator erase(iterator first, iterator last)
+ {
+ const auto elements_affected = std::distance(first, last);
+ const auto offset = std::distance(Container::begin(), first);
+
+ // This is the start situation. We need to delete elements_affected
+ // elements (3 in this example: e, f, g), and need to return an
+ // iterator past the last deleted element (h in this example).
+ // Note that offset is the distance from the start of the vector
+ // to first. We will need this later.
+
+ // [ a, b, c, d, e, f, g, h, i, j ]
+ // ^ ^
+ // first last
+
+ // Since we cannot move const Keys, we re-construct them in place.
+ // We start at first and re-construct (viz. copy) the elements from
+ // the back of the vector. Example for first iteration:
- // Since we cannot move const Keys, re-construct them in place
- for (auto next = it; ++next != this->end(); ++it)
+ // ,--------.
+ // v | destroy e and re-construct with h
+ // [ a, b, c, d, e, f, g, h, i, j ]
+ // ^ ^
+ // it it + elements_affected
+
+ for (auto it = first; std::next(it, elements_affected) != Container::end(); ++it)
{
- it->~value_type(); // Destroy but keep allocation
- new (&*it) value_type{std::move(*next)};
+ it->~value_type(); // destroy but keep allocation
+ new (&*it) value_type{std::move(*std::next(it, elements_affected))}; // "move" next element to it
}
- Container::pop_back();
- return pos;
+
+ // [ a, b, c, d, h, i, j, h, i, j ]
+ // ^ ^
+ // first last
+
+ // remove the unneeded elements at the end of the vector
+ Container::resize(this->size() - static_cast<size_type>(elements_affected));
+
+ // [ a, b, c, d, h, i, j ]
+ // ^ ^
+ // first last
+
+ // first is now pointing past the last deleted element, but we cannot
+ // use this iterator, because it may have been invalidated by the
+ // resize call. Instead, we can return begin() + offset.
+ return Container::begin() + offset;
}
size_type count(const Key& key) const
@@ -17592,69 +17262,7 @@ namespace nlohmann
/*!
@brief a class to store JSON values
-@tparam ObjectType type for JSON objects (`std::map` by default; will be used
-in @ref object_t)
-@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
-in @ref array_t)
-@tparam StringType type for JSON strings and object keys (`std::string` by
-default; will be used in @ref string_t)
-@tparam BooleanType type for JSON booleans (`bool` by default; will be used
-in @ref boolean_t)
-@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
-default; will be used in @ref number_integer_t)
-@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
-`uint64_t` by default; will be used in @ref number_unsigned_t)
-@tparam NumberFloatType type for JSON floating-point numbers (`double` by
-default; will be used in @ref number_float_t)
-@tparam BinaryType type for packed binary data for compatibility with binary
-serialization formats (`std::vector<std::uint8_t>` by default; will be used in
-@ref binary_t)
-@tparam AllocatorType type of the allocator to use (`std::allocator` by
-default)
-@tparam JSONSerializer the serializer to resolve internal calls to `to_json()`
-and `from_json()` (@ref adl_serializer by default)
-
-@requirement The class satisfies the following concept requirements:
-- Basic
- - [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible):
- JSON values can be default constructed. The result will be a JSON null
- value.
- - [MoveConstructible](https://en.cppreference.com/w/cpp/named_req/MoveConstructible):
- A JSON value can be constructed from an rvalue argument.
- - [CopyConstructible](https://en.cppreference.com/w/cpp/named_req/CopyConstructible):
- A JSON value can be copy-constructed from an lvalue expression.
- - [MoveAssignable](https://en.cppreference.com/w/cpp/named_req/MoveAssignable):
- A JSON value van be assigned from an rvalue argument.
- - [CopyAssignable](https://en.cppreference.com/w/cpp/named_req/CopyAssignable):
- A JSON value can be copy-assigned from an lvalue expression.
- - [Destructible](https://en.cppreference.com/w/cpp/named_req/Destructible):
- JSON values can be destructed.
-- Layout
- - [StandardLayoutType](https://en.cppreference.com/w/cpp/named_req/StandardLayoutType):
- JSON values have
- [standard layout](https://en.cppreference.com/w/cpp/language/data_members#Standard_layout):
- All non-static data members are private and standard layout types, the
- class has no virtual functions or (virtual) base classes.
-- Library-wide
- - [EqualityComparable](https://en.cppreference.com/w/cpp/named_req/EqualityComparable):
- JSON values can be compared with `==`, see @ref
- operator==(const_reference,const_reference).
- - [LessThanComparable](https://en.cppreference.com/w/cpp/named_req/LessThanComparable):
- JSON values can be compared with `<`, see @ref
- operator<(const_reference,const_reference).
- - [Swappable](https://en.cppreference.com/w/cpp/named_req/Swappable):
- Any JSON lvalue or rvalue of can be swapped with any lvalue or rvalue of
- other compatible types, using unqualified function call @ref swap().
- - [NullablePointer](https://en.cppreference.com/w/cpp/named_req/NullablePointer):
- JSON values can be compared against `std::nullptr_t` objects which are used
- to model the `null` value.
-- Container
- - [Container](https://en.cppreference.com/w/cpp/named_req/Container):
- JSON values can be used like STL containers and provide iterator access.
- - [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer);
- JSON values can be used like STL containers and provide reverse iterator
- access.
-
+@internal
@invariant The member variables @a m_value and @a m_type have the following
relationship:
- If `m_type == value_t::object`, then `m_value.object != nullptr`.
@@ -17662,13 +17270,9 @@ relationship:
- If `m_type == value_t::string`, then `m_value.string != nullptr`.
The invariants are checked by member function assert_invariant().
-@internal
@note ObjectType trick from https://stackoverflow.com/a/9860911
@endinternal
-@see [RFC 8259: The JavaScript Object Notation (JSON) Data Interchange
-Format](https://tools.ietf.org/html/rfc8259)
-
@since version 1.0.0
@nosubgrouping
@@ -17759,17 +17363,11 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// Classes to implement user-defined exceptions.
/// @{
- /// @copydoc detail::exception
using exception = detail::exception;
- /// @copydoc detail::parse_error
using parse_error = detail::parse_error;
- /// @copydoc detail::invalid_iterator
using invalid_iterator = detail::invalid_iterator;
- /// @copydoc detail::type_error
using type_error = detail::type_error;
- /// @copydoc detail::out_of_range
using out_of_range = detail::out_of_range;
- /// @copydoc detail::other_error
using other_error = detail::other_error;
/// @}
@@ -17817,46 +17415,21 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @}
- /*!
- @brief returns the allocator associated with the container
- */
+ /// @brief returns the allocator associated with the container
+ /// @sa https://json.nlohmann.me/api/basic_json/get_allocator/
static allocator_type get_allocator()
{
return allocator_type();
}
- /*!
- @brief returns version information on the library
-
- This function returns a JSON object with information about the library,
- including the version number and information on the platform and compiler.
-
- @return JSON object holding version information
- 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`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version).
- `copyright` | The copyright line for 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`.
- `url` | The URL of the project as string.
- `version` | The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by [Semantic Versioning](http://semver.org), and `string` (the version string).
-
- @liveexample{The following code shows an example output of the `meta()`
- function.,meta}
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @complexity Constant.
-
- @since 2.1.0
- */
+ /// @brief returns version information on the library
+ /// @sa https://json.nlohmann.me/api/basic_json/meta/
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json meta()
{
basic_json result;
- result["copyright"] = "(C) 2013-2021 Niels Lohmann";
+ result["copyright"] = "(C) 2013-2022 Niels Lohmann";
result["name"] = "JSON for Modern C++";
result["url"] = "https://github.com/nlohmann/json";
result["version"]["string"] =
@@ -17917,6 +17490,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// the template arguments passed to class @ref basic_json.
/// @{
+ /// @brief object key comparator type
+ /// @sa https://json.nlohmann.me/api/basic_json/object_comparator_t/
#if defined(JSON_HAS_CPP_14)
// Use transparent comparator if possible, combined with perfect forwarding
// on find() and count() calls prevents unnecessary string construction.
@@ -17925,501 +17500,42 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
using object_comparator_t = std::less<StringType>;
#endif
- /*!
- @brief a type for an object
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) describes JSON objects as follows:
- > An object is an unordered collection of zero or more name/value pairs,
- > where a name is a string and a value is a string, number, boolean, null,
- > object, or array.
-
- To store objects in C++, a type is defined by the template parameters
- described below.
-
- @tparam ObjectType the container to store objects (e.g., `std::map` or
- `std::unordered_map`)
- @tparam StringType the type of the keys or names (e.g., `std::string`).
- The comparison function `std::less<StringType>` is used to order elements
- inside the container.
- @tparam AllocatorType the allocator to use for objects (e.g.,
- `std::allocator`)
-
- #### Default type
-
- With the default values for @a ObjectType (`std::map`), @a StringType
- (`std::string`), and @a AllocatorType (`std::allocator`), the default
- value for @a object_t is:
-
- @code {.cpp}
- std::map<
- std::string, // key_type
- basic_json, // value_type
- std::less<std::string>, // key_compare
- std::allocator<std::pair<const std::string, basic_json>> // allocator_type
- >
- @endcode
-
- #### Behavior
-
- The choice of @a object_t influences the behavior of the JSON class. With
- the default type, objects have the following behavior:
-
- - When all names are unique, objects will be interoperable in the sense
- that all software implementations receiving that object will agree on
- the name-value mappings.
- - When the names within an object are not unique, it is unspecified which
- one of the values for a given key will be chosen. For instance,
- `{"key": 2, "key": 1}` could be equal to either `{"key": 1}` or
- `{"key": 2}`.
- - Internally, name/value pairs are stored in lexicographical order of the
- names. Objects will also be serialized (see @ref dump) in this order.
- For instance, `{"b": 1, "a": 2}` and `{"a": 2, "b": 1}` will be stored
- and serialized as `{"a": 2, "b": 1}`.
- - When comparing objects, the order of the name/value pairs is irrelevant.
- This makes objects interoperable in the sense that they will not be
- affected by these differences. For instance, `{"b": 1, "a": 2}` and
- `{"a": 2, "b": 1}` will be treated as equal.
-
- #### Limits
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) specifies:
- > An implementation may set limits on the maximum depth of nesting.
-
- In this class, the object's limit of nesting is not explicitly constrained.
- However, a maximum depth of nesting may be introduced by the compiler or
- runtime environment. A theoretical limit can be queried by calling the
- @ref max_size function of a JSON object.
-
- #### Storage
-
- Objects are stored as pointers in a @ref basic_json type. That is, for any
- access to object values, a pointer of type `object_t*` must be
- dereferenced.
-
- @sa see @ref array_t -- type for an array value
-
- @since version 1.0.0
-
- @note The order name/value pairs are added to the object is *not*
- preserved by the library. Therefore, iterating an object may return
- name/value pairs in a different order than they were originally stored. In
- fact, keys will be traversed in alphabetical order as `std::map` with
- `std::less` is used by default. Please note this behavior conforms to [RFC
- 8259](https://tools.ietf.org/html/rfc8259), because any order implements the
- specified "unordered" nature of JSON objects.
- */
+ /// @brief a type for an object
+ /// @sa https://json.nlohmann.me/api/basic_json/object_t/
using object_t = ObjectType<StringType,
basic_json,
object_comparator_t,
AllocatorType<std::pair<const StringType,
basic_json>>>;
- /*!
- @brief a type for an array
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) describes JSON arrays as follows:
- > An array is an ordered sequence of zero or more values.
-
- To store objects in C++, a type is defined by the template parameters
- explained below.
-
- @tparam ArrayType container type to store arrays (e.g., `std::vector` or
- `std::list`)
- @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
-
- #### Default type
-
- With the default values for @a ArrayType (`std::vector`) and @a
- AllocatorType (`std::allocator`), the default value for @a array_t is:
-
- @code {.cpp}
- std::vector<
- basic_json, // value_type
- std::allocator<basic_json> // allocator_type
- >
- @endcode
-
- #### Limits
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) specifies:
- > An implementation may set limits on the maximum depth of nesting.
-
- In this class, the array's limit of nesting is not explicitly constrained.
- However, a maximum depth of nesting may be introduced by the compiler or
- runtime environment. A theoretical limit can be queried by calling the
- @ref max_size function of a JSON array.
-
- #### Storage
-
- Arrays are stored as pointers in a @ref basic_json type. That is, for any
- access to array values, a pointer of type `array_t*` must be dereferenced.
-
- @sa see @ref object_t -- type for an object value
-
- @since version 1.0.0
- */
+ /// @brief a type for an array
+ /// @sa https://json.nlohmann.me/api/basic_json/array_t/
using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
- /*!
- @brief a type for a string
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) describes JSON strings as follows:
- > A string is a sequence of zero or more Unicode characters.
-
- To store objects in C++, a type is defined by the template parameter
- described below. Unicode values are split by the JSON class into
- byte-sized characters during deserialization.
-
- @tparam StringType the container to store strings (e.g., `std::string`).
- Note this container is used for keys/names in objects, see @ref object_t.
-
- #### Default type
-
- With the default values for @a StringType (`std::string`), the default
- value for @a string_t is:
-
- @code {.cpp}
- std::string
- @endcode
-
- #### Encoding
-
- Strings are stored in UTF-8 encoding. Therefore, functions like
- `std::string::size()` or `std::string::length()` return the number of
- bytes in the string rather than the number of characters or glyphs.
-
- #### String comparison
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) states:
- > Software implementations are typically required to test names of object
- > members for equality. Implementations that transform the textual
- > representation into sequences of Unicode code units and then perform the
- > comparison numerically, code unit by code unit, are interoperable in the
- > sense that implementations will agree in all cases on equality or
- > inequality of two strings. For example, implementations that compare
- > strings with escaped characters unconverted may incorrectly find that
- > `"a\\b"` and `"a\u005Cb"` are not equal.
-
- This implementation is interoperable as it does compare strings code unit
- by code unit.
-
- #### Storage
-
- String values are stored as pointers in a @ref basic_json type. That is,
- for any access to string values, a pointer of type `string_t*` must be
- dereferenced.
-
- @since version 1.0.0
- */
+ /// @brief a type for a string
+ /// @sa https://json.nlohmann.me/api/basic_json/string_t/
using string_t = StringType;
- /*!
- @brief a type for a boolean
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) implicitly describes a boolean as a
- type which differentiates the two literals `true` and `false`.
-
- To store objects in C++, a type is defined by the template parameter @a
- BooleanType which chooses the type to use.
-
- #### Default type
-
- With the default values for @a BooleanType (`bool`), the default value for
- @a boolean_t is:
-
- @code {.cpp}
- bool
- @endcode
-
- #### Storage
-
- Boolean values are stored directly inside a @ref basic_json type.
-
- @since version 1.0.0
- */
+ /// @brief a type for a boolean
+ /// @sa https://json.nlohmann.me/api/basic_json/boolean_t/
using boolean_t = BooleanType;
- /*!
- @brief a type for a number (integer)
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) describes numbers as follows:
- > The representation of numbers is similar to that used in most
- > programming languages. A number is represented in base 10 using decimal
- > digits. It contains an integer component that may be prefixed with an
- > optional minus sign, which may be followed by a fraction part and/or an
- > exponent part. Leading zeros are not allowed. (...) Numeric values that
- > cannot be represented in the grammar below (such as Infinity and NaN)
- > are not permitted.
-
- This description includes both integer and floating-point numbers.
- However, C++ allows more precise storage if it is known whether the number
- is a signed integer, an unsigned integer or a floating-point number.
- Therefore, three different types, @ref number_integer_t, @ref
- number_unsigned_t and @ref number_float_t are used.
-
- To store integer numbers in C++, a type is defined by the template
- parameter @a NumberIntegerType which chooses the type to use.
-
- #### Default type
-
- With the default values for @a NumberIntegerType (`int64_t`), the default
- value for @a number_integer_t is:
-
- @code {.cpp}
- int64_t
- @endcode
-
- #### Default behavior
-
- - The restrictions about leading zeros is not enforced in C++. Instead,
- leading zeros in integer literals lead to an interpretation as octal
- number. Internally, the value will be stored as decimal number. For
- instance, the C++ integer literal `010` will be serialized to `8`.
- During deserialization, leading zeros yield an error.
- - Not-a-number (NaN) values will be serialized to `null`.
-
- #### Limits
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) specifies:
- > An implementation may set limits on the range and precision of numbers.
-
- When the default type is used, the maximal integer number that can be
- stored is `9223372036854775807` (INT64_MAX) and the minimal integer number
- that can be stored is `-9223372036854775808` (INT64_MIN). Integer numbers
- that are out of range will yield over/underflow when used in a
- constructor. During deserialization, too large or small integer numbers
- will be automatically be stored as @ref number_unsigned_t or @ref
- number_float_t.
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) further states:
- > Note that when such software is used, numbers that are integers and are
- > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense
- > that implementations will agree exactly on their numeric values.
-
- As this range is a subrange of the exactly supported range [INT64_MIN,
- INT64_MAX], this class's integer type is interoperable.
-
- #### Storage
-
- Integer number values are stored directly inside a @ref basic_json type.
-
- @sa see @ref number_float_t -- type for number values (floating-point)
-
- @sa see @ref number_unsigned_t -- type for number values (unsigned integer)
-
- @since version 1.0.0
- */
+ /// @brief a type for a number (integer)
+ /// @sa https://json.nlohmann.me/api/basic_json/number_integer_t/
using number_integer_t = NumberIntegerType;
- /*!
- @brief a type for a number (unsigned)
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) describes numbers as follows:
- > The representation of numbers is similar to that used in most
- > programming languages. A number is represented in base 10 using decimal
- > digits. It contains an integer component that may be prefixed with an
- > optional minus sign, which may be followed by a fraction part and/or an
- > exponent part. Leading zeros are not allowed. (...) Numeric values that
- > cannot be represented in the grammar below (such as Infinity and NaN)
- > are not permitted.
-
- This description includes both integer and floating-point numbers.
- However, C++ allows more precise storage if it is known whether the number
- is a signed integer, an unsigned integer or a floating-point number.
- Therefore, three different types, @ref number_integer_t, @ref
- number_unsigned_t and @ref number_float_t are used.
-
- To store unsigned integer numbers in C++, a type is defined by the
- template parameter @a NumberUnsignedType which chooses the type to use.
-
- #### Default type
-
- With the default values for @a NumberUnsignedType (`uint64_t`), the
- default value for @a number_unsigned_t is:
-
- @code {.cpp}
- uint64_t
- @endcode
-
- #### Default behavior
-
- - The restrictions about leading zeros is not enforced in C++. Instead,
- leading zeros in integer literals lead to an interpretation as octal
- number. Internally, the value will be stored as decimal number. For
- instance, the C++ integer literal `010` will be serialized to `8`.
- During deserialization, leading zeros yield an error.
- - Not-a-number (NaN) values will be serialized to `null`.
-
- #### Limits
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) specifies:
- > An implementation may set limits on the range and precision of numbers.
-
- When the default type is used, the maximal integer number that can be
- stored is `18446744073709551615` (UINT64_MAX) and the minimal integer
- number that can be stored is `0`. Integer numbers that are out of range
- will yield over/underflow when used in a constructor. During
- deserialization, too large or small integer numbers will be automatically
- be stored as @ref number_integer_t or @ref number_float_t.
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) further states:
- > Note that when such software is used, numbers that are integers and are
- > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense
- > that implementations will agree exactly on their numeric values.
-
- As this range is a subrange (when considered in conjunction with the
- number_integer_t type) of the exactly supported range [0, UINT64_MAX],
- this class's integer type is interoperable.
-
- #### Storage
-
- Integer number values are stored directly inside a @ref basic_json type.
-
- @sa see @ref number_float_t -- type for number values (floating-point)
- @sa see @ref number_integer_t -- type for number values (integer)
-
- @since version 2.0.0
- */
+ /// @brief a type for a number (unsigned)
+ /// @sa https://json.nlohmann.me/api/basic_json/number_unsigned_t/
using number_unsigned_t = NumberUnsignedType;
- /*!
- @brief a type for a number (floating-point)
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) describes numbers as follows:
- > The representation of numbers is similar to that used in most
- > programming languages. A number is represented in base 10 using decimal
- > digits. It contains an integer component that may be prefixed with an
- > optional minus sign, which may be followed by a fraction part and/or an
- > exponent part. Leading zeros are not allowed. (...) Numeric values that
- > cannot be represented in the grammar below (such as Infinity and NaN)
- > are not permitted.
-
- This description includes both integer and floating-point numbers.
- However, C++ allows more precise storage if it is known whether the number
- is a signed integer, an unsigned integer or a floating-point number.
- Therefore, three different types, @ref number_integer_t, @ref
- number_unsigned_t and @ref number_float_t are used.
-
- To store floating-point numbers in C++, a type is defined by the template
- parameter @a NumberFloatType which chooses the type to use.
-
- #### Default type
-
- With the default values for @a NumberFloatType (`double`), the default
- value for @a number_float_t is:
-
- @code {.cpp}
- double
- @endcode
-
- #### Default behavior
-
- - The restrictions about leading zeros is not enforced in C++. Instead,
- leading zeros in floating-point literals will be ignored. Internally,
- the value will be stored as decimal number. For instance, the C++
- floating-point literal `01.2` will be serialized to `1.2`. During
- deserialization, leading zeros yield an error.
- - Not-a-number (NaN) values will be serialized to `null`.
-
- #### Limits
-
- [RFC 8259](https://tools.ietf.org/html/rfc8259) states:
- > This specification allows implementations to set limits on the range and
- > precision of numbers accepted. Since software that implements IEEE
- > 754-2008 binary64 (double precision) numbers is generally available and
- > widely used, good interoperability can be achieved by implementations
- > that expect no more precision or range than these provide, in the sense
- > that implementations will approximate JSON numbers within the expected
- > precision.
-
- This implementation does exactly follow this approach, as it uses double
- precision floating-point numbers. Note values smaller than
- `-1.79769313486232e+308` and values greater than `1.79769313486232e+308`
- will be stored as NaN internally and be serialized to `null`.
-
- #### Storage
-
- Floating-point number values are stored directly inside a @ref basic_json
- type.
-
- @sa see @ref number_integer_t -- type for number values (integer)
-
- @sa see @ref number_unsigned_t -- type for number values (unsigned integer)
-
- @since version 1.0.0
- */
+ /// @brief a type for a number (floating-point)
+ /// @sa https://json.nlohmann.me/api/basic_json/number_float_t/
using number_float_t = NumberFloatType;
- /*!
- @brief a type for a packed binary type
-
- This type is a type designed to carry binary data that appears in various
- serialized formats, such as CBOR's Major Type 2, MessagePack's bin, and
- BSON's generic binary subtype. This type is NOT a part of standard JSON and
- exists solely for compatibility with these binary types. As such, it is
- simply defined as an ordered sequence of zero or more byte values.
-
- Additionally, as an implementation detail, the subtype of the binary data is
- carried around as a `std::uint8_t`, which is compatible with both of the
- binary data formats that use binary subtyping, (though the specific
- numbering is incompatible with each other, and it is up to the user to
- translate between them).
-
- [CBOR's RFC 7049](https://tools.ietf.org/html/rfc7049) describes this type
- as:
- > Major type 2: a byte string. The string's length in bytes is represented
- > following the rules for positive integers (major type 0).
-
- [MessagePack's documentation on the bin type
- family](https://github.com/msgpack/msgpack/blob/master/spec.md#bin-format-family)
- describes this type as:
- > Bin format family stores an byte array in 2, 3, or 5 bytes of extra bytes
- > in addition to the size of the byte array.
-
- [BSON's specifications](http://bsonspec.org/spec.html) describe several
- binary types; however, this type is intended to represent the generic binary
- type which has the description:
- > Generic binary subtype - This is the most commonly used binary subtype and
- > should be the 'default' for drivers and tools.
-
- None of these impose any limitations on the internal representation other
- than the basic unit of storage be some type of array whose parts are
- decomposable into bytes.
-
- The default representation of this binary format is a
- `std::vector<std::uint8_t>`, which is a very common way to represent a byte
- array in modern C++.
-
- #### Default type
-
- The default values for @a BinaryType is `std::vector<std::uint8_t>`
-
- #### Storage
-
- Binary Arrays are stored as pointers in a @ref basic_json type. That is,
- for any access to array values, a pointer of the type `binary_t*` must be
- dereferenced.
-
- #### Notes on subtypes
-
- - CBOR
- - Binary values are represented as byte strings. Subtypes are serialized
- as tagged values.
- - MessagePack
- - If a subtype is given and the binary array contains exactly 1, 2, 4, 8,
- or 16 elements, the fixext family (fixext1, fixext2, fixext4, fixext8)
- is used. For other sizes, the ext family (ext8, ext16, ext32) is used.
- The subtype is then added as singed 8-bit integer.
- - If no subtype is given, the bin family (bin8, bin16, bin32) is used.
- - BSON
- - If a subtype is given, it is used and added as unsigned 8-bit integer.
- - If no subtype is given, the generic binary subtype 0x00 is used.
-
- @sa see @ref binary -- create a binary array
-
- @since version 3.8.0
- */
+ /// @brief a type for a packed binary type
+ /// @sa https://json.nlohmann.me/api/basic_json/binary_t/
using binary_t = nlohmann::byte_container_with_subtype<BinaryType>;
+
/// @}
private:
@@ -18532,25 +17648,25 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
case value_t::boolean:
{
- boolean = boolean_t(false);
+ boolean = static_cast<boolean_t>(false);
break;
}
case value_t::number_integer:
{
- number_integer = number_integer_t(0);
+ number_integer = static_cast<number_integer_t>(0);
break;
}
case value_t::number_unsigned:
{
- number_unsigned = number_unsigned_t(0);
+ number_unsigned = static_cast<number_unsigned_t>(0);
break;
}
case value_t::number_float:
{
- number_float = number_float_t(0.0);
+ number_float = static_cast<number_float_t>(0.0);
break;
}
@@ -18566,7 +17682,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
object = nullptr; // silence warning, see #821
if (JSON_HEDLEY_UNLIKELY(t == value_t::null))
{
- JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 3.10.4", basic_json())); // LCOV_EXCL_LINE
+ JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 3.10.5", basic_json())); // LCOV_EXCL_LINE
}
break;
}
@@ -18574,64 +17690,34 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
/// constructor for strings
- json_value(const string_t& value)
- {
- string = create<string_t>(value);
- }
+ json_value(const string_t& value) : string(create<string_t>(value)) {}
/// constructor for rvalue strings
- json_value(string_t&& value)
- {
- string = create<string_t>(std::move(value));
- }
+ json_value(string_t&& value) : string(create<string_t>(std::move(value))) {}
/// constructor for objects
- json_value(const object_t& value)
- {
- object = create<object_t>(value);
- }
+ json_value(const object_t& value) : object(create<object_t>(value)) {}
/// constructor for rvalue objects
- json_value(object_t&& value)
- {
- object = create<object_t>(std::move(value));
- }
+ json_value(object_t&& value) : object(create<object_t>(std::move(value))) {}
/// constructor for arrays
- json_value(const array_t& value)
- {
- array = create<array_t>(value);
- }
+ json_value(const array_t& value) : array(create<array_t>(value)) {}
/// constructor for rvalue arrays
- json_value(array_t&& value)
- {
- array = create<array_t>(std::move(value));
- }
+ json_value(array_t&& value) : array(create<array_t>(std::move(value))) {}
/// constructor for binary arrays
- json_value(const typename binary_t::container_type& value)
- {
- binary = create<binary_t>(value);
- }
+ json_value(const typename binary_t::container_type& value) : binary(create<binary_t>(value)) {}
/// constructor for rvalue binary arrays
- json_value(typename binary_t::container_type&& value)
- {
- binary = create<binary_t>(std::move(value));
- }
+ json_value(typename binary_t::container_type&& value) : binary(create<binary_t>(std::move(value))) {}
/// constructor for binary arrays (internal type)
- json_value(const binary_t& value)
- {
- binary = create<binary_t>(value);
- }
+ json_value(const binary_t& value) : binary(create<binary_t>(value)) {}
/// constructor for rvalue binary arrays (internal type)
- json_value(binary_t&& value)
- {
- binary = create<binary_t>(std::move(value));
- }
+ json_value(binary_t&& value) : binary(create<binary_t>(std::move(value))) {}
void destroy(value_t t)
{
@@ -18809,23 +17895,23 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
#endif
}
- iterator set_parents(iterator it, typename iterator::difference_type count)
+ iterator set_parents(iterator it, typename iterator::difference_type count_set_parents)
{
#if JSON_DIAGNOSTICS
- for (typename iterator::difference_type i = 0; i < count; ++i)
+ for (typename iterator::difference_type i = 0; i < count_set_parents; ++i)
{
(it + i)->m_parent = this;
}
#else
- static_cast<void>(count);
+ static_cast<void>(count_set_parents);
#endif
return it;
}
- reference set_parent(reference j, std::size_t old_capacity = std::size_t(-1))
+ reference set_parent(reference j, std::size_t old_capacity = static_cast<std::size_t>(-1))
{
#if JSON_DIAGNOSTICS
- if (old_capacity != std::size_t(-1))
+ if (old_capacity != static_cast<std::size_t>(-1))
{
// see https://github.com/nlohmann/json/issues/2838
JSON_ASSERT(type() == value_t::array);
@@ -18865,72 +17951,12 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
// JSON parser callback //
//////////////////////////
- /*!
- @brief parser event types
-
- The parser callback distinguishes the following events:
- - `object_start`: the parser read `{` and started to process a JSON object
- - `key`: the parser read a key of a value in an object
- - `object_end`: the parser read `}` and finished processing a JSON object
- - `array_start`: the parser read `[` and started to process a JSON array
- - `array_end`: the parser read `]` and finished processing a JSON array
- - `value`: the parser finished reading a JSON value
-
- @image html callback_events.png "Example when certain parse events are triggered"
-
- @sa see @ref parser_callback_t for more information and examples
- */
+ /// @brief parser event types
+ /// @sa https://json.nlohmann.me/api/basic_json/parse_event_t/
using parse_event_t = detail::parse_event_t;
- /*!
- @brief per-element parser callback type
-
- With a parser callback function, the result of parsing a JSON text can be
- influenced. When passed to @ref parse, it is called on certain events
- (passed as @ref parse_event_t via parameter @a event) with a set recursion
- depth @a depth and context JSON value @a parsed. The return value of the
- callback function is a boolean indicating whether the element that emitted
- the callback shall be kept or not.
-
- We distinguish six scenarios (determined by the event type) in which the
- callback function can be called. The following table describes the values
- of the parameters @a depth, @a event, and @a parsed.
-
- parameter @a event | description | parameter @a depth | parameter @a parsed
- ------------------ | ----------- | ------------------ | -------------------
- parse_event_t::object_start | the parser read `{` and started to process a JSON object | depth of the parent of the JSON object | a JSON value with type discarded
- parse_event_t::key | the parser read a key of a value in an object | depth of the currently parsed JSON object | a JSON string containing the key
- parse_event_t::object_end | the parser read `}` and finished processing a JSON object | depth of the parent of the JSON object | the parsed JSON object
- parse_event_t::array_start | the parser read `[` and started to process a JSON array | depth of the parent of the JSON array | a JSON value with type discarded
- parse_event_t::array_end | the parser read `]` and finished processing a JSON array | depth of the parent of the JSON array | the parsed JSON array
- parse_event_t::value | the parser finished reading a JSON value | depth of the value | the parsed JSON value
-
- @image html callback_events.png "Example when certain parse events are triggered"
-
- Discarding a value (i.e., returning `false`) has different effects
- depending on the context in which function was called:
-
- - Discarded values in structured types are skipped. That is, the parser
- will behave as if the discarded value was never read.
- - In case a value outside a structured type is skipped, it is replaced
- with `null`. This case happens if the top-level element is skipped.
-
- @param[in] depth the depth of the recursion during parsing
-
- @param[in] event an event of type parse_event_t indicating the context in
- the callback function has been called
-
- @param[in,out] parsed the current intermediate parse result; note that
- writing to this value has no effect for parse_event_t::key events
-
- @return Whether the JSON value which called the function during parsing
- should be kept (`true`) or not (`false`). In the latter case, it is either
- skipped completely or replaced by an empty discarded object.
-
- @sa see @ref parse for examples
-
- @since version 1.0.0
- */
+ /// @brief per-element parser callback type
+ /// @sa https://json.nlohmann.me/api/basic_json/parser_callback_t/
using parser_callback_t = detail::parser_callback_t<basic_json>;
//////////////////
@@ -18942,128 +17968,24 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// assignment, static functions creating objects, and the destructor.
/// @{
- /*!
- @brief create an empty value with a given type
-
- Create an empty JSON value with a given type. The value will be default
- initialized with an empty value which depends on the type:
-
- Value type | initial value
- ----------- | -------------
- null | `null`
- boolean | `false`
- string | `""`
- number | `0`
- object | `{}`
- array | `[]`
- binary | empty array
-
- @param[in] v the type of the value to create
-
- @complexity Constant.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @liveexample{The following code shows the constructor for different @ref
- value_t values,basic_json__value_t}
-
- @sa see @ref clear() -- restores the postcondition of this constructor
-
- @since version 1.0.0
- */
+ /// @brief create an empty value with a given type
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
basic_json(const value_t v)
: m_type(v), m_value(v)
{
assert_invariant();
}
- /*!
- @brief create a null object
-
- Create a `null` JSON value. It either takes a null pointer as parameter
- (explicitly creating `null`) or no parameter (implicitly creating `null`).
- The passed null pointer itself is not read -- it is only used to choose
- the right constructor.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this constructor never throws
- exceptions.
-
- @liveexample{The following code shows the constructor with and without a
- null pointer parameter.,basic_json__nullptr_t}
-
- @since version 1.0.0
- */
+ /// @brief create a null object
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
basic_json(std::nullptr_t = nullptr) noexcept
: basic_json(value_t::null)
{
assert_invariant();
}
- /*!
- @brief create a JSON value
-
- This is a "catch all" constructor for all compatible JSON types; that is,
- types for which a `to_json()` method exists. The constructor forwards the
- parameter @a val to that method (to `json_serializer<U>::to_json` method
- with `U = uncvref_t<CompatibleType>`, to be exact).
-
- Template type @a CompatibleType includes, but is not limited to, the
- following types:
- - **arrays**: @ref array_t and all kinds of compatible containers such as
- `std::vector`, `std::deque`, `std::list`, `std::forward_list`,
- `std::array`, `std::valarray`, `std::set`, `std::unordered_set`,
- `std::multiset`, and `std::unordered_multiset` with a `value_type` from
- which a @ref basic_json value can be constructed.
- - **objects**: @ref object_t and all kinds of compatible associative
- containers such as `std::map`, `std::unordered_map`, `std::multimap`,
- and `std::unordered_multimap` with a `key_type` compatible to
- @ref string_t and a `value_type` from which a @ref basic_json value can
- be constructed.
- - **strings**: @ref string_t, string literals, and all compatible string
- containers can be used.
- - **numbers**: @ref number_integer_t, @ref number_unsigned_t,
- @ref number_float_t, and all convertible number types such as `int`,
- `size_t`, `int64_t`, `float` or `double` can be used.
- - **boolean**: @ref boolean_t / `bool` can be used.
- - **binary**: @ref binary_t / `std::vector<std::uint8_t>` may be used,
- unfortunately because string literals cannot be distinguished from binary
- character arrays by the C++ type system, all types compatible with `const
- char*` will be directed to the string constructor instead. This is both
- for backwards compatibility, and due to the fact that a binary type is not
- a standard JSON type.
-
- See the examples below.
-
- @tparam CompatibleType a type such that:
- - @a CompatibleType is not derived from `std::istream`,
- - @a CompatibleType is not @ref basic_json (to avoid hijacking copy/move
- constructors),
- - @a CompatibleType is not a different @ref basic_json type (i.e. with different template arguments)
- - @a CompatibleType is not a @ref basic_json nested type (e.g.,
- @ref json_pointer, @ref iterator, etc ...)
- - `json_serializer<U>` has a `to_json(basic_json_t&, CompatibleType&&)` method
-
- @tparam U = `uncvref_t<CompatibleType>`
-
- @param[in] val the value to be forwarded to the respective constructor
-
- @complexity Usually linear in the size of the passed @a val, also
- depending on the implementation of the called `to_json()`
- method.
-
- @exceptionsafety Depends on the called constructor. For types directly
- supported by the library (i.e., all types for which no `to_json()` function
- was provided), strong guarantee holds: if an exception is thrown, there are
- no changes to any JSON value.
-
- @liveexample{The following code shows the constructor with several
- compatible types.,basic_json__CompatibleType}
-
- @since version 2.1.0
- */
+ /// @brief create a JSON value from compatible types
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
template < typename CompatibleType,
typename U = detail::uncvref_t<CompatibleType>,
detail::enable_if_t <
@@ -19077,32 +17999,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
assert_invariant();
}
- /*!
- @brief create a JSON value from an existing one
-
- This is a constructor for existing @ref basic_json types.
- It does not hijack copy/move constructors, since the parameter has different
- template arguments than the current ones.
-
- The constructor tries to convert the internal @ref m_value of the parameter.
-
- @tparam BasicJsonType a type such that:
- - @a BasicJsonType is a @ref basic_json type.
- - @a BasicJsonType has different template arguments than @ref basic_json_t.
-
- @param[in] val the @ref basic_json value to be converted.
-
- @complexity Usually linear in the size of the passed @a val, also
- depending on the implementation of the called `to_json()`
- method.
-
- @exceptionsafety Depends on the called constructor. For types directly
- supported by the library (i.e., all types for which no `to_json()` function
- was provided), strong guarantee holds: if an exception is thrown, there are
- no changes to any JSON value.
-
- @since version 3.2.0
- */
+ /// @brief create a JSON value from an existing one
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
template < typename BasicJsonType,
detail::enable_if_t <
detail::is_basic_json<BasicJsonType>::value&& !std::is_same<basic_json, BasicJsonType>::value, int > = 0 >
@@ -19156,80 +18054,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
assert_invariant();
}
- /*!
- @brief create a container (array or object) from an initializer list
-
- Creates a JSON value of type array or object from the passed initializer
- list @a init. In case @a type_deduction is `true` (default), the type of
- the JSON value to be created is deducted from the initializer list @a init
- according to the following rules:
-
- 1. If the list is empty, an empty JSON object value `{}` is created.
- 2. If the list consists of pairs whose first element is a string, a JSON
- object value is created where the first elements of the pairs are
- treated as keys and the second elements are as values.
- 3. In all other cases, an array is created.
-
- The rules aim to create the best fit between a C++ initializer list and
- JSON values. The rationale is as follows:
-
- 1. The empty initializer list is written as `{}` which is exactly an empty
- JSON object.
- 2. C++ has no way of describing mapped types other than to list a list of
- pairs. As JSON requires that keys must be of type string, rule 2 is the
- weakest constraint one can pose on initializer lists to interpret them
- as an object.
- 3. In all other cases, the initializer list could not be interpreted as
- JSON object type, so interpreting it as JSON array type is safe.
-
- With the rules described above, the following JSON values cannot be
- expressed by an initializer list:
-
- - the empty array (`[]`): use @ref array(initializer_list_t)
- with an empty initializer list in this case
- - arrays whose elements satisfy rule 2: use @ref
- array(initializer_list_t) with the same initializer list
- in this case
-
- @note When used without parentheses around an empty initializer list, @ref
- basic_json() is called instead of this function, yielding the JSON null
- value.
-
- @param[in] init initializer list with JSON values
-
- @param[in] type_deduction internal parameter; when set to `true`, the type
- of the JSON value is deducted from the initializer list @a init; when set
- to `false`, the type provided via @a manual_type is forced. This mode is
- used by the functions @ref array(initializer_list_t) and
- @ref object(initializer_list_t).
-
- @param[in] manual_type internal parameter; when @a type_deduction is set
- to `false`, the created JSON value will use the provided type (only @ref
- value_t::array and @ref value_t::object are valid); when @a type_deduction
- is set to `true`, this parameter has no effect
-
- @throw type_error.301 if @a type_deduction is `false`, @a manual_type is
- `value_t::object`, but @a init contains an element which is not a pair
- whose first element is a string. In this case, the constructor could not
- create an object. If @a type_deduction would have be `true`, an array
- would have been created. See @ref object(initializer_list_t)
- for an example.
-
- @complexity Linear in the size of the initializer list @a init.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @liveexample{The example below shows how JSON values are created from
- initializer lists.,basic_json__list_init_t}
-
- @sa see @ref array(initializer_list_t) -- create a JSON array
- value from an initializer list
- @sa see @ref object(initializer_list_t) -- create a JSON object
- value from an initializer list
-
- @since version 1.0.0
- */
+ /// @brief create a container (array or object) from an initializer list
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
basic_json(initializer_list_t init,
bool type_deduction = true,
value_t manual_type = value_t::array)
@@ -19283,33 +18109,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
assert_invariant();
}
- /*!
- @brief explicitly create a binary array (without subtype)
-
- Creates a JSON binary array value from a given binary container. Binary
- values are part of various binary formats, such as CBOR, MessagePack, and
- BSON. This constructor is used to create a value for serialization to those
- formats.
-
- @note Note, this function exists because of the difficulty in correctly
- specifying the correct template overload in the standard value ctor, as both
- JSON arrays and JSON binary arrays are backed with some form of a
- `std::vector`. Because JSON binary arrays are a non-standard extension it
- was decided that it would be best to prevent automatic initialization of a
- binary array type, for backwards compatibility and so it does not happen on
- accident.
-
- @param[in] init container containing bytes to use as binary type
-
- @return JSON binary array value
-
- @complexity Linear in the size of @a init.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @since version 3.8.0
- */
+ /// @brief explicitly create a binary array (without subtype)
+ /// @sa https://json.nlohmann.me/api/basic_json/binary/
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json binary(const typename binary_t::container_type& init)
{
@@ -19319,34 +18120,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res;
}
- /*!
- @brief explicitly create a binary array (with subtype)
-
- Creates a JSON binary array value from a given binary container. Binary
- values are part of various binary formats, such as CBOR, MessagePack, and
- BSON. This constructor is used to create a value for serialization to those
- formats.
-
- @note Note, this function exists because of the difficulty in correctly
- specifying the correct template overload in the standard value ctor, as both
- JSON arrays and JSON binary arrays are backed with some form of a
- `std::vector`. Because JSON binary arrays are a non-standard extension it
- was decided that it would be best to prevent automatic initialization of a
- binary array type, for backwards compatibility and so it does not happen on
- accident.
-
- @param[in] init container containing bytes to use as binary type
- @param[in] subtype subtype to use in MessagePack and BSON
-
- @return JSON binary array value
-
- @complexity Linear in the size of @a init.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @since version 3.8.0
- */
+ /// @brief explicitly create a binary array (with subtype)
+ /// @sa https://json.nlohmann.me/api/basic_json/binary/
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json binary(const typename binary_t::container_type& init, typename binary_t::subtype_type subtype)
{
@@ -19356,7 +18131,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res;
}
- /// @copydoc binary(const typename binary_t::container_type&)
+ /// @brief explicitly create a binary array
+ /// @sa https://json.nlohmann.me/api/basic_json/binary/
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json binary(typename binary_t::container_type&& init)
{
@@ -19366,7 +18142,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res;
}
- /// @copydoc binary(const typename binary_t::container_type&, typename binary_t::subtype_type)
+ /// @brief explicitly create a binary array (with subtype)
+ /// @sa https://json.nlohmann.me/api/basic_json/binary/
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json binary(typename binary_t::container_type&& init, typename binary_t::subtype_type subtype)
{
@@ -19376,115 +18153,24 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res;
}
- /*!
- @brief explicitly create an array from an initializer list
-
- Creates a JSON array value from a given initializer list. That is, given a
- list of values `a, b, c`, creates the JSON value `[a, b, c]`. If the
- initializer list is empty, the empty array `[]` is created.
-
- @note This function is only needed to express two edge cases that cannot
- be realized with the initializer list constructor (@ref
- basic_json(initializer_list_t, bool, value_t)). These cases
- are:
- 1. creating an array whose elements are all pairs whose first element is a
- string -- in this case, the initializer list constructor would create an
- object, taking the first elements as keys
- 2. creating an empty array -- passing the empty initializer list to the
- initializer list constructor yields an empty object
-
- @param[in] init initializer list with JSON values to create an array from
- (optional)
-
- @return JSON array value
-
- @complexity Linear in the size of @a init.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @liveexample{The following code shows an example for the `array`
- function.,array}
-
- @sa see @ref basic_json(initializer_list_t, bool, value_t) --
- create a JSON value from an initializer list
- @sa see @ref object(initializer_list_t) -- create a JSON object
- value from an initializer list
-
- @since version 1.0.0
- */
+ /// @brief explicitly create an array from an initializer list
+ /// @sa https://json.nlohmann.me/api/basic_json/array/
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json array(initializer_list_t init = {})
{
return basic_json(init, false, value_t::array);
}
- /*!
- @brief explicitly create an object from an initializer list
-
- Creates a JSON object value from a given initializer list. The initializer
- lists elements must be pairs, and their first elements must be strings. If
- the initializer list is empty, the empty object `{}` is created.
-
- @note This function is only added for symmetry reasons. In contrast to the
- related function @ref array(initializer_list_t), there are
- no cases which can only be expressed by this function. That is, any
- initializer list @a init can also be passed to the initializer list
- constructor @ref basic_json(initializer_list_t, bool, value_t).
-
- @param[in] init initializer list to create an object from (optional)
-
- @return JSON object value
-
- @throw type_error.301 if @a init is not a list of pairs whose first
- elements are strings. In this case, no object can be created. When such a
- value is passed to @ref basic_json(initializer_list_t, bool, value_t),
- an array would have been created from the passed initializer list @a init.
- See example below.
-
- @complexity Linear in the size of @a init.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @liveexample{The following code shows an example for the `object`
- function.,object}
-
- @sa see @ref basic_json(initializer_list_t, bool, value_t) --
- create a JSON value from an initializer list
- @sa see @ref array(initializer_list_t) -- create a JSON array
- value from an initializer list
-
- @since version 1.0.0
- */
+ /// @brief explicitly create an object from an initializer list
+ /// @sa https://json.nlohmann.me/api/basic_json/object/
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json object(initializer_list_t init = {})
{
return basic_json(init, false, value_t::object);
}
- /*!
- @brief construct an array with count copies of given value
-
- Constructs a JSON array value by creating @a cnt copies of a passed value.
- In case @a cnt is `0`, an empty array is created.
-
- @param[in] cnt the number of JSON copies of @a val to create
- @param[in] val the JSON value to copy
-
- @post `std::distance(begin(),end()) == cnt` holds.
-
- @complexity Linear in @a cnt.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @liveexample{The following code shows examples for the @ref
- basic_json(size_type\, const basic_json&)
- constructor.,basic_json__size_type_basic_json}
-
- @since version 1.0.0
- */
+ /// @brief construct an array with count copies of given value
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
basic_json(size_type cnt, const basic_json& val)
: m_type(value_t::array)
{
@@ -19493,61 +18179,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
assert_invariant();
}
- /*!
- @brief construct a JSON container given an iterator range
-
- Constructs the JSON value with the contents of the range `[first, last)`.
- The semantics depends on the different types a JSON value can have:
- - In case of a null type, invalid_iterator.206 is thrown.
- - In case of other primitive types (number, boolean, or string), @a first
- must be `begin()` and @a last must be `end()`. In this case, the value is
- copied. Otherwise, invalid_iterator.204 is thrown.
- - In case of structured types (array, object), the constructor behaves as
- similar versions for `std::vector` or `std::map`; that is, a JSON array
- or object is constructed from the values in the range.
-
- @tparam InputIT an input iterator type (@ref iterator or @ref
- const_iterator)
-
- @param[in] first begin of the range to copy from (included)
- @param[in] last end of the range to copy from (excluded)
-
- @pre Iterators @a first and @a last must be initialized. **This
- precondition is enforced with an assertion (see warning).** If
- assertions are switched off, a violation of this precondition yields
- undefined behavior.
-
- @pre Range `[first, last)` is valid. Usually, this precondition cannot be
- checked efficiently. Only certain edge cases are detected; see the
- description of the exceptions below. A violation of this precondition
- yields undefined behavior.
-
- @warning A precondition is enforced with a runtime assertion that will
- result in calling `std::abort` if this precondition is not met.
- Assertions can be disabled by defining `NDEBUG` at compile time.
- See https://en.cppreference.com/w/cpp/error/assert for more
- information.
-
- @throw invalid_iterator.201 if iterators @a first and @a last are not
- compatible (i.e., do not belong to the same JSON value). In this case,
- the range `[first, last)` is undefined.
- @throw invalid_iterator.204 if iterators @a first and @a last belong to a
- primitive type (number, boolean, or string), but @a first does not point
- to the first element any more. In this case, the range `[first, last)` is
- undefined. See example code below.
- @throw invalid_iterator.206 if iterators @a first and @a last belong to a
- null value. In this case, the range `[first, last)` is undefined.
-
- @complexity Linear in distance between @a first and @a last.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @liveexample{The example below shows several ways to create JSON values by
- specifying a subrange with iterators.,basic_json__InputIt_InputIt}
-
- @since version 1.0.0
- */
+ /// @brief construct a JSON container given an iterator range
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
template < class InputIT, typename std::enable_if <
std::is_same<InputIT, typename basic_json_t::iterator>::value ||
std::is_same<InputIT, typename basic_json_t::const_iterator>::value, int >::type = 0 >
@@ -19663,31 +18296,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
std::is_same<typename JsonRef::value_type, basic_json>>::value, int> = 0 >
basic_json(const JsonRef& ref) : basic_json(ref.moved_or_copied()) {}
- /*!
- @brief copy constructor
-
- Creates a copy of a given JSON value.
-
- @param[in] other the JSON value to copy
-
- @post `*this == other`
-
- @complexity Linear in the size of @a other.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes to any JSON value.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is linear.
- - As postcondition, it holds: `other == basic_json(other)`.
-
- @liveexample{The following code shows an example for the copy
- constructor.,basic_json__basic_json}
-
- @since version 1.0.0
- */
+ /// @brief copy constructor
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
basic_json(const basic_json& other)
: m_type(other.m_type)
{
@@ -19754,32 +18364,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
assert_invariant();
}
- /*!
- @brief move constructor
-
- Move constructor. Constructs a JSON value with the contents of the given
- value @a other using move semantics. It "steals" the resources from @a
- other and leaves it as JSON null value.
-
- @param[in,out] other value to move to this object
-
- @post `*this` has the same value as @a other before the call.
- @post @a other is a JSON null value.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this constructor never throws
- exceptions.
-
- @requirement This function helps `basic_json` satisfying the
- [MoveConstructible](https://en.cppreference.com/w/cpp/named_req/MoveConstructible)
- requirements.
-
- @liveexample{The code below shows the move constructor explicitly called
- via std::move.,basic_json__moveconstructor}
-
- @since version 1.0.0
- */
+ /// @brief move constructor
+ /// @sa https://json.nlohmann.me/api/basic_json/basic_json/
basic_json(basic_json&& other) noexcept
: m_type(std::move(other.m_type)),
m_value(std::move(other.m_value))
@@ -19795,29 +18381,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
assert_invariant();
}
- /*!
- @brief copy assignment
-
- Copy assignment operator. Copies a JSON value via the "copy and swap"
- strategy: It is expressed in terms of the copy constructor, destructor,
- and the `swap()` member function.
-
- @param[in] other value to copy from
-
- @complexity Linear.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is linear.
-
- @liveexample{The code below shows and example for the copy assignment. It
- creates a copy of value `a` which is then swapped with `b`. Finally\, the
- copy of `a` (which is the null value after the swap) is
- destroyed.,basic_json__copyassignment}
-
- @since version 1.0.0
- */
+ /// @brief copy assignment
+ /// @sa https://json.nlohmann.me/api/basic_json/operator=/
basic_json& operator=(basic_json other) noexcept (
std::is_nothrow_move_constructible<value_t>::value&&
std::is_nothrow_move_assignable<value_t>::value&&
@@ -19837,21 +18402,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return *this;
}
- /*!
- @brief destructor
-
- Destroys the JSON value and frees all allocated memory.
-
- @complexity Linear.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is linear.
- - All stored elements are destroyed and all memory is freed.
-
- @since version 1.0.0
- */
+ /// @brief destructor
+ /// @sa https://json.nlohmann.me/api/basic_json/~basic_json/
~basic_json() noexcept
{
assert_invariant(false);
@@ -19869,53 +18421,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// Functions to inspect the type of a JSON value.
/// @{
- /*!
- @brief serialization
-
- Serialization function for JSON values. The function tries to mimic
- Python's `json.dumps()` function, and currently supports its @a indent
- and @a ensure_ascii parameters.
-
- @param[in] indent If indent is nonnegative, then array elements and object
- members will be pretty-printed with that indent level. An indent level of
- `0` will only insert newlines. `-1` (the default) selects the most compact
- representation.
- @param[in] indent_char The character to use for indentation if @a indent is
- greater than `0`. The default is ` ` (space).
- @param[in] ensure_ascii If @a ensure_ascii is true, all non-ASCII characters
- in the output are escaped with `\uXXXX` sequences, and the result consists
- of ASCII characters only.
- @param[in] error_handler how to react on decoding errors; there are three
- possible values: `strict` (throws and exception in case a decoding error
- occurs; default), `replace` (replace invalid UTF-8 sequences with U+FFFD),
- and `ignore` (ignore invalid UTF-8 sequences during serialization; all
- bytes are copied to the output unchanged).
-
- @return string containing the serialization of the JSON value
-
- @throw type_error.316 if a string stored inside the JSON value is not
- UTF-8 encoded and @a error_handler is set to strict
-
- @note Binary values are serialized as object containing two keys:
- - "bytes": an array of bytes as integers
- - "subtype": the subtype as integer or "null" if the binary has no subtype
-
- @complexity Linear.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @liveexample{The following example shows the effect of different @a indent\,
- @a indent_char\, and @a ensure_ascii parameters to the result of the
- serialization.,dump}
-
- @see https://docs.python.org/2/library/json.html#json.dump
-
- @since version 1.0.0; indentation character @a indent_char, option
- @a ensure_ascii and exceptions added in version 3.0.0; error
- handlers added in version 3.4.0; serialization of binary values added
- in version 3.8.0.
- */
+ /// @brief serialization
+ /// @sa https://json.nlohmann.me/api/basic_json/dump/
string_t dump(const int indent = -1,
const char indent_char = ' ',
const bool ensure_ascii = false,
@@ -19936,397 +18443,106 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief return the type of the JSON value (explicit)
-
- Return the type of the JSON value as a value from the @ref value_t
- enumeration.
-
- @return the type of the JSON value
- Value type | return value
- ------------------------- | -------------------------
- null | value_t::null
- boolean | value_t::boolean
- string | value_t::string
- number (integer) | value_t::number_integer
- number (unsigned integer) | value_t::number_unsigned
- number (floating-point) | value_t::number_float
- object | value_t::object
- array | value_t::array
- binary | value_t::binary
- discarded | value_t::discarded
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `type()` for all JSON
- types.,type}
-
- @sa see @ref operator value_t() -- return the type of the JSON value (implicit)
- @sa see @ref type_name() -- return the type as string
-
- @since version 1.0.0
- */
+ /// @brief return the type of the JSON value (explicit)
+ /// @sa https://json.nlohmann.me/api/basic_json/type/
constexpr value_t type() const noexcept
{
return m_type;
}
- /*!
- @brief return whether type is primitive
-
- This function returns true if and only if the JSON type is primitive
- (string, number, boolean, or null).
-
- @return `true` if type is primitive (string, number, boolean, or null),
- `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_primitive()` for all JSON
- types.,is_primitive}
-
- @sa see @ref is_structured() -- returns whether JSON value is structured
- @sa see @ref is_null() -- returns whether JSON value is `null`
- @sa see @ref is_string() -- returns whether JSON value is a string
- @sa see @ref is_boolean() -- returns whether JSON value is a boolean
- @sa see @ref is_number() -- returns whether JSON value is a number
- @sa see @ref is_binary() -- returns whether JSON value is a binary array
-
- @since version 1.0.0
- */
+ /// @brief return whether type is primitive
+ /// @sa https://json.nlohmann.me/api/basic_json/is_primitive/
constexpr bool is_primitive() const noexcept
{
return is_null() || is_string() || is_boolean() || is_number() || is_binary();
}
- /*!
- @brief return whether type is structured
-
- This function returns true if and only if the JSON type is structured
- (array or object).
-
- @return `true` if type is structured (array or object), `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_structured()` for all JSON
- types.,is_structured}
-
- @sa see @ref is_primitive() -- returns whether value is primitive
- @sa see @ref is_array() -- returns whether value is an array
- @sa see @ref is_object() -- returns whether value is an object
-
- @since version 1.0.0
- */
+ /// @brief return whether type is structured
+ /// @sa https://json.nlohmann.me/api/basic_json/is_structured/
constexpr bool is_structured() const noexcept
{
return is_array() || is_object();
}
- /*!
- @brief return whether value is null
-
- This function returns true if and only if the JSON value is null.
-
- @return `true` if type is null, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_null()` for all JSON
- types.,is_null}
-
- @since version 1.0.0
- */
+ /// @brief return whether value is null
+ /// @sa https://json.nlohmann.me/api/basic_json/is_null/
constexpr bool is_null() const noexcept
{
return m_type == value_t::null;
}
- /*!
- @brief return whether value is a boolean
-
- This function returns true if and only if the JSON value is a boolean.
-
- @return `true` if type is boolean, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_boolean()` for all JSON
- types.,is_boolean}
-
- @since version 1.0.0
- */
+ /// @brief return whether value is a boolean
+ /// @sa https://json.nlohmann.me/api/basic_json/is_boolean/
constexpr bool is_boolean() const noexcept
{
return m_type == value_t::boolean;
}
- /*!
- @brief return whether value is a number
-
- This function returns true if and only if the JSON value is a number. This
- includes both integer (signed and unsigned) and floating-point values.
-
- @return `true` if type is number (regardless whether integer, unsigned
- integer or floating-type), `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_number()` for all JSON
- types.,is_number}
-
- @sa see @ref is_number_integer() -- check if value is an integer or unsigned
- integer number
- @sa see @ref is_number_unsigned() -- check if value is an unsigned integer
- number
- @sa see @ref is_number_float() -- check if value is a floating-point number
-
- @since version 1.0.0
- */
+ /// @brief return whether value is a number
+ /// @sa https://json.nlohmann.me/api/basic_json/is_number/
constexpr bool is_number() const noexcept
{
return is_number_integer() || is_number_float();
}
- /*!
- @brief return whether value is an integer number
-
- This function returns true if and only if the JSON value is a signed or
- unsigned integer number. This excludes floating-point values.
-
- @return `true` if type is an integer or unsigned integer number, `false`
- otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_number_integer()` for all
- JSON types.,is_number_integer}
-
- @sa see @ref is_number() -- check if value is a number
- @sa see @ref is_number_unsigned() -- check if value is an unsigned integer
- number
- @sa see @ref is_number_float() -- check if value is a floating-point number
-
- @since version 1.0.0
- */
+ /// @brief return whether value is an integer number
+ /// @sa https://json.nlohmann.me/api/basic_json/is_number_integer/
constexpr bool is_number_integer() const noexcept
{
return m_type == value_t::number_integer || m_type == value_t::number_unsigned;
}
- /*!
- @brief return whether value is an unsigned integer number
-
- This function returns true if and only if the JSON value is an unsigned
- integer number. This excludes floating-point and signed integer values.
-
- @return `true` if type is an unsigned integer number, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_number_unsigned()` for all
- JSON types.,is_number_unsigned}
-
- @sa see @ref is_number() -- check if value is a number
- @sa see @ref is_number_integer() -- check if value is an integer or unsigned
- integer number
- @sa see @ref is_number_float() -- check if value is a floating-point number
-
- @since version 2.0.0
- */
+ /// @brief return whether value is an unsigned integer number
+ /// @sa https://json.nlohmann.me/api/basic_json/is_number_unsigned/
constexpr bool is_number_unsigned() const noexcept
{
return m_type == value_t::number_unsigned;
}
- /*!
- @brief return whether value is a floating-point number
-
- This function returns true if and only if the JSON value is a
- floating-point number. This excludes signed and unsigned integer values.
-
- @return `true` if type is a floating-point number, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_number_float()` for all
- JSON types.,is_number_float}
-
- @sa see @ref is_number() -- check if value is number
- @sa see @ref is_number_integer() -- check if value is an integer number
- @sa see @ref is_number_unsigned() -- check if value is an unsigned integer
- number
-
- @since version 1.0.0
- */
+ /// @brief return whether value is a floating-point number
+ /// @sa https://json.nlohmann.me/api/basic_json/is_number_float/
constexpr bool is_number_float() const noexcept
{
return m_type == value_t::number_float;
}
- /*!
- @brief return whether value is an object
-
- This function returns true if and only if the JSON value is an object.
-
- @return `true` if type is object, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_object()` for all JSON
- types.,is_object}
-
- @since version 1.0.0
- */
+ /// @brief return whether value is an object
+ /// @sa https://json.nlohmann.me/api/basic_json/is_object/
constexpr bool is_object() const noexcept
{
return m_type == value_t::object;
}
- /*!
- @brief return whether value is an array
-
- This function returns true if and only if the JSON value is an array.
-
- @return `true` if type is array, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_array()` for all JSON
- types.,is_array}
-
- @since version 1.0.0
- */
+ /// @brief return whether value is an array
+ /// @sa https://json.nlohmann.me/api/basic_json/is_array/
constexpr bool is_array() const noexcept
{
return m_type == value_t::array;
}
- /*!
- @brief return whether value is a string
-
- This function returns true if and only if the JSON value is a string.
-
- @return `true` if type is string, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_string()` for all JSON
- types.,is_string}
-
- @since version 1.0.0
- */
+ /// @brief return whether value is a string
+ /// @sa https://json.nlohmann.me/api/basic_json/is_string/
constexpr bool is_string() const noexcept
{
return m_type == value_t::string;
}
- /*!
- @brief return whether value is a binary array
-
- This function returns true if and only if the JSON value is a binary array.
-
- @return `true` if type is binary array, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_binary()` for all JSON
- types.,is_binary}
-
- @since version 3.8.0
- */
+ /// @brief return whether value is a binary array
+ /// @sa https://json.nlohmann.me/api/basic_json/is_binary/
constexpr bool is_binary() const noexcept
{
return m_type == value_t::binary;
}
- /*!
- @brief return whether value is discarded
-
- This function returns true if and only if the JSON value was discarded
- during parsing with a callback function (see @ref parser_callback_t).
-
- @note This function will always be `false` for JSON values after parsing.
- That is, discarded values can only occur during parsing, but will be
- removed when inside a structured value or replaced by null in other cases.
-
- @return `true` if type is discarded, `false` otherwise.
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies `is_discarded()` for all JSON
- types.,is_discarded}
-
- @since version 1.0.0
- */
+ /// @brief return whether value is discarded
+ /// @sa https://json.nlohmann.me/api/basic_json/is_discarded/
constexpr bool is_discarded() const noexcept
{
return m_type == value_t::discarded;
}
- /*!
- @brief return the type of the JSON value (implicit)
-
- Implicitly return the type of the JSON value as a value from the @ref
- value_t enumeration.
-
- @return the type of the JSON value
-
- @complexity Constant.
-
- @exceptionsafety No-throw guarantee: this member function never throws
- exceptions.
-
- @liveexample{The following code exemplifies the @ref value_t operator for
- all JSON types.,operator__value_t}
-
- @sa see @ref type() -- return the type of the JSON value (explicit)
- @sa see @ref type_name() -- return the type as string
-
- @since version 1.0.0
- */
+ /// @brief return the type of the JSON value (implicit)
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_value_t/
constexpr operator value_t() const noexcept
{
return m_type;
@@ -20476,32 +18692,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// Direct access to the stored value of a JSON value.
/// @{
- /*!
- @brief get a pointer value (implicit)
-
- Implicit pointer access to the internally stored JSON value. No copies are
- made.
-
- @warning Writing data to the pointee of the result yields an undefined
- state.
-
- @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref
- object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
- @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
- assertion.
-
- @return pointer to the internally stored JSON value if the requested
- pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
-
- @complexity Constant.
-
- @liveexample{The example below shows how pointers to internal values of a
- JSON value can be requested. Note that no type conversions are made and a
- `nullptr` is returned if the value and the requested pointer type does not
- match.,get_ptr}
-
- @since version 1.0.0
- */
+ /// @brief get a pointer value (implicit)
+ /// @sa https://json.nlohmann.me/api/basic_json/get_ptr/
template<typename PointerType, typename std::enable_if<
std::is_pointer<PointerType>::value, int>::type = 0>
auto get_ptr() noexcept -> decltype(std::declval<basic_json_t&>().get_impl_ptr(std::declval<PointerType>()))
@@ -20510,10 +18702,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return get_impl_ptr(static_cast<PointerType>(nullptr));
}
- /*!
- @brief get a pointer value (implicit)
- @copydoc get_ptr()
- */
+ /// @brief get a pointer value (implicit)
+ /// @sa https://json.nlohmann.me/api/basic_json/get_ptr/
template < typename PointerType, typename std::enable_if <
std::is_pointer<PointerType>::value&&
std::is_const<typename std::remove_pointer<PointerType>::type>::value, int >::type = 0 >
@@ -20752,39 +18942,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return get_ptr<PointerType>();
}
- /*!
- @brief get a value (explicit)
-
- Explicit type conversion between the JSON value and a compatible value.
- The value is filled into the input parameter by calling the @ref json_serializer<ValueType>
- `from_json()` method.
-
- The function is equivalent to executing
- @code {.cpp}
- ValueType v;
- JSONSerializer<ValueType>::from_json(*this, v);
- @endcode
-
- This overloads is chosen if:
- - @a ValueType is not @ref basic_json,
- - @ref json_serializer<ValueType> has a `from_json()` method of the form
- `void from_json(const basic_json&, ValueType&)`, and
-
- @tparam ValueType the input parameter type.
-
- @return the input parameter, allowing chaining calls.
-
- @throw what @ref json_serializer<ValueType> `from_json()` method throws
-
- @liveexample{The example below shows several conversions from JSON values
- to other types. There a few things to note: (1) Floating-point numbers can
- be converted to integers\, (2) A JSON array can be converted to a standard
- `std::vector<short>`\, (3) A JSON object can be converted to C++
- associative containers such as `std::unordered_map<std::string\,
- json>`.,get_to}
-
- @since version 3.3.0
- */
+ /// @brief get a value (explicit)
+ /// @sa https://json.nlohmann.me/api/basic_json/get_to/
template < typename ValueType,
detail::enable_if_t <
!detail::is_basic_json<ValueType>::value&&
@@ -20797,7 +18956,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return v;
}
- // specialization to allow to call get_to with a basic_json value
+ // specialization to allow calling get_to with a basic_json value
// see https://github.com/nlohmann/json/issues/2175
template<typename ValueType,
detail::enable_if_t <
@@ -20822,32 +18981,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return v;
}
- /*!
- @brief get a reference value (implicit)
-
- Implicit reference access to the internally stored JSON value. No copies
- are made.
-
- @warning Writing data to the referee of the result yields an undefined
- state.
-
- @tparam ReferenceType reference type; must be a reference to @ref array_t,
- @ref object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, or
- @ref number_float_t. Enforced by static assertion.
-
- @return reference to the internally stored JSON value if the requested
- reference type @a ReferenceType fits to the JSON value; throws
- type_error.303 otherwise
-
- @throw type_error.303 in case passed type @a ReferenceType is incompatible
- with the stored JSON value; see example below
-
- @complexity Constant.
-
- @liveexample{The example shows several calls to `get_ref()`.,get_ref}
-
- @since version 1.1.0
- */
+ /// @brief get a reference value (implicit)
+ /// @sa https://json.nlohmann.me/api/basic_json/get_ref/
template<typename ReferenceType, typename std::enable_if<
std::is_reference<ReferenceType>::value, int>::type = 0>
ReferenceType get_ref()
@@ -20856,10 +18991,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return get_ref_impl<ReferenceType>(*this);
}
- /*!
- @brief get a reference value (implicit)
- @copydoc get_ref()
- */
+ /// @brief get a reference value (implicit)
+ /// @sa https://json.nlohmann.me/api/basic_json/get_ref/
template < typename ReferenceType, typename std::enable_if <
std::is_reference<ReferenceType>::value&&
std::is_const<typename std::remove_reference<ReferenceType>::type>::value, int >::type = 0 >
@@ -20917,15 +19050,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return get<ValueType>();
}
- /*!
- @return reference to the binary value
-
- @throw type_error.302 if the value is not binary
-
- @sa see @ref is_binary() to check if the value is binary
-
- @since version 3.8.0
- */
+ /// @brief get a binary value
+ /// @sa https://json.nlohmann.me/api/basic_json/get_binary/
binary_t& get_binary()
{
if (!is_binary())
@@ -20936,7 +19062,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return *get_ptr<binary_t*>();
}
- /// @copydoc get_binary()
+ /// @brief get a binary value
+ /// @sa https://json.nlohmann.me/api/basic_json/get_binary/
const binary_t& get_binary() const
{
if (!is_binary())
@@ -20958,32 +19085,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// Access to the JSON value.
/// @{
- /*!
- @brief access specified array element with bounds checking
-
- Returns a reference to the element at specified location @a idx, with
- bounds checking.
-
- @param[in] idx index of the element to access
-
- @return reference to the element at index @a idx
-
- @throw type_error.304 if the JSON value is not an array; in this case,
- calling `at` with an index makes no sense. See example below.
- @throw out_of_range.401 if the index @a idx is out of range of the array;
- that is, `idx >= size()`. See example below.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @complexity Constant.
-
- @since version 1.0.0
-
- @liveexample{The example below shows how array elements can be read and
- written using `at()`. It also demonstrates the different exceptions that
- can be thrown.,at__size_type}
- */
+ /// @brief access specified array element with bounds checking
+ /// @sa https://json.nlohmann.me/api/basic_json/at/
reference at(size_type idx)
{
// at only works for arrays
@@ -21005,32 +19108,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief access specified array element with bounds checking
-
- Returns a const reference to the element at specified location @a idx,
- with bounds checking.
-
- @param[in] idx index of the element to access
-
- @return const reference to the element at index @a idx
-
- @throw type_error.304 if the JSON value is not an array; in this case,
- calling `at` with an index makes no sense. See example below.
- @throw out_of_range.401 if the index @a idx is out of range of the array;
- that is, `idx >= size()`. See example below.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @complexity Constant.
-
- @since version 1.0.0
-
- @liveexample{The example below shows how array elements can be read using
- `at()`. It also demonstrates the different exceptions that can be thrown.,
- at__size_type_const}
- */
+ /// @brief access specified array element with bounds checking
+ /// @sa https://json.nlohmann.me/api/basic_json/at/
const_reference at(size_type idx) const
{
// at only works for arrays
@@ -21052,36 +19131,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief access specified object element with bounds checking
-
- Returns a reference to the element at with specified key @a key, with
- bounds checking.
-
- @param[in] key key of the element to access
-
- @return reference to the element at key @a key
-
- @throw type_error.304 if the JSON value is not an object; in this case,
- calling `at` with a key makes no sense. See example below.
- @throw out_of_range.403 if the key @a key is is not stored in the object;
- that is, `find(key) == end()`. See example below.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @complexity Logarithmic in the size of the container.
-
- @sa see @ref operator[](const typename object_t::key_type&) for unchecked
- access by reference
- @sa see @ref value() for access by value with a default value
-
- @since version 1.0.0
-
- @liveexample{The example below shows how object elements can be read and
- written using `at()`. It also demonstrates the different exceptions that
- can be thrown.,at__object_t_key_type}
- */
+ /// @brief access specified object element with bounds checking
+ /// @sa https://json.nlohmann.me/api/basic_json/at/
reference at(const typename object_t::key_type& key)
{
// at only works for objects
@@ -21103,36 +19154,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief access specified object element with bounds checking
-
- Returns a const reference to the element at with specified key @a key,
- with bounds checking.
-
- @param[in] key key of the element to access
-
- @return const reference to the element at key @a key
-
- @throw type_error.304 if the JSON value is not an object; in this case,
- calling `at` with a key makes no sense. See example below.
- @throw out_of_range.403 if the key @a key is is not stored in the object;
- that is, `find(key) == end()`. See example below.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @complexity Logarithmic in the size of the container.
-
- @sa see @ref operator[](const typename object_t::key_type&) for unchecked
- access by reference
- @sa see @ref value() for access by value with a default value
-
- @since version 1.0.0
-
- @liveexample{The example below shows how object elements can be read using
- `at()`. It also demonstrates the different exceptions that can be thrown.,
- at__object_t_key_type_const}
- */
+ /// @brief access specified object element with bounds checking
+ /// @sa https://json.nlohmann.me/api/basic_json/at/
const_reference at(const typename object_t::key_type& key) const
{
// at only works for objects
@@ -21154,31 +19177,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief access specified array element
-
- Returns a reference to the element at specified location @a idx.
-
- @note If @a idx is beyond the range of the array (i.e., `idx >= size()`),
- then the array is silently filled up with `null` values to make `idx` a
- valid reference to the last stored element.
-
- @param[in] idx index of the element to access
-
- @return reference to the element at index @a idx
-
- @throw type_error.305 if the JSON value is not an array or null; in that
- cases, using the [] operator with an index makes no sense.
-
- @complexity Constant if @a idx is in the range of the array. Otherwise
- linear in `idx - size()`.
-
- @liveexample{The example below shows how array elements can be read and
- written using `[]` operator. Note the addition of `null`
- values.,operatorarray__size_type}
-
- @since version 1.0.0
- */
+ /// @brief access specified array element
+ /// @sa https://json.nlohmann.me/api/basic_json/operator%5B%5D/
reference operator[](size_type idx)
{
// implicitly convert null value to an empty array
@@ -21223,25 +19223,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(305, "cannot use operator[] with a numeric argument with " + std::string(type_name()), *this));
}
- /*!
- @brief access specified array element
-
- Returns a const reference to the element at specified location @a idx.
-
- @param[in] idx index of the element to access
-
- @return const reference to the element at index @a idx
-
- @throw type_error.305 if the JSON value is not an array; in that case,
- using the [] operator with an index makes no sense.
-
- @complexity Constant.
-
- @liveexample{The example below shows how array elements can be read using
- the `[]` operator.,operatorarray__size_type_const}
-
- @since version 1.0.0
- */
+ /// @brief access specified array element
+ /// @sa https://json.nlohmann.me/api/basic_json/operator%5B%5D/
const_reference operator[](size_type idx) const
{
// const operator[] only works for arrays
@@ -21253,33 +19236,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(305, "cannot use operator[] with a numeric argument with " + std::string(type_name()), *this));
}
- /*!
- @brief access specified object element
-
- Returns a reference to the element at with specified key @a key.
-
- @note If @a key is not found in the object, then it is silently added to
- the object and filled with a `null` value to make `key` a valid reference.
- In case the value was `null` before, it is converted to an object.
-
- @param[in] key key of the element to access
-
- @return reference to the element at key @a key
-
- @throw type_error.305 if the JSON value is not an object or null; in that
- cases, using the [] operator with a key makes no sense.
-
- @complexity Logarithmic in the size of the container.
-
- @liveexample{The example below shows how object elements can be read and
- written using the `[]` operator.,operatorarray__key_type}
-
- @sa see @ref at(const typename object_t::key_type&) for access by reference
- with range checking
- @sa see @ref value() for access by value with a default value
-
- @since version 1.0.0
- */
+ /// @brief access specified object element
+ /// @sa https://json.nlohmann.me/api/basic_json/operator%5B%5D/
reference operator[](const typename object_t::key_type& key)
{
// implicitly convert null value to an empty object
@@ -21299,36 +19257,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(305, "cannot use operator[] with a string argument with " + std::string(type_name()), *this));
}
- /*!
- @brief read-only access specified object element
-
- Returns a const reference to the element at with specified key @a key. No
- bounds checking is performed.
-
- @warning If the element with key @a key does not exist, the behavior is
- undefined.
-
- @param[in] key key of the element to access
-
- @return const reference to the element at key @a key
-
- @pre The element with key @a key must exist. **This precondition is
- enforced with an assertion.**
-
- @throw type_error.305 if the JSON value is not an object; in that case,
- using the [] operator with a key makes no sense.
-
- @complexity Logarithmic in the size of the container.
-
- @liveexample{The example below shows how object elements can be read using
- the `[]` operator.,operatorarray__key_type_const}
-
- @sa see @ref at(const typename object_t::key_type&) for access by reference
- with range checking
- @sa see @ref value() for access by value with a default value
-
- @since version 1.0.0
- */
+ /// @brief access specified object element
+ /// @sa https://json.nlohmann.me/api/basic_json/operator%5B%5D/
const_reference operator[](const typename object_t::key_type& key) const
{
// const operator[] only works for objects
@@ -21341,33 +19271,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(305, "cannot use operator[] with a string argument with " + std::string(type_name()), *this));
}
- /*!
- @brief access specified object element
-
- Returns a reference to the element at with specified key @a key.
-
- @note If @a key is not found in the object, then it is silently added to
- the object and filled with a `null` value to make `key` a valid reference.
- In case the value was `null` before, it is converted to an object.
-
- @param[in] key key of the element to access
-
- @return reference to the element at key @a key
-
- @throw type_error.305 if the JSON value is not an object or null; in that
- cases, using the [] operator with a key makes no sense.
-
- @complexity Logarithmic in the size of the container.
-
- @liveexample{The example below shows how object elements can be read and
- written using the `[]` operator.,operatorarray__key_type}
-
- @sa see @ref at(const typename object_t::key_type&) for access by reference
- with range checking
- @sa see @ref value() for access by value with a default value
-
- @since version 1.1.0
- */
+ /// @brief access specified object element
+ /// @sa https://json.nlohmann.me/api/basic_json/operator%5B%5D/
template<typename T>
JSON_HEDLEY_NON_NULL(2)
reference operator[](T* key)
@@ -21389,36 +19294,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(305, "cannot use operator[] with a string argument with " + std::string(type_name()), *this));
}
- /*!
- @brief read-only access specified object element
-
- Returns a const reference to the element at with specified key @a key. No
- bounds checking is performed.
-
- @warning If the element with key @a key does not exist, the behavior is
- undefined.
-
- @param[in] key key of the element to access
-
- @return const reference to the element at key @a key
-
- @pre The element with key @a key must exist. **This precondition is
- enforced with an assertion.**
-
- @throw type_error.305 if the JSON value is not an object; in that case,
- using the [] operator with a key makes no sense.
-
- @complexity Logarithmic in the size of the container.
-
- @liveexample{The example below shows how object elements can be read using
- the `[]` operator.,operatorarray__key_type_const}
-
- @sa see @ref at(const typename object_t::key_type&) for access by reference
- with range checking
- @sa see @ref value() for access by value with a default value
-
- @since version 1.1.0
- */
+ /// @brief access specified object element
+ /// @sa https://json.nlohmann.me/api/basic_json/operator%5B%5D/
template<typename T>
JSON_HEDLEY_NON_NULL(2)
const_reference operator[](T* key) const
@@ -21433,57 +19310,9 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(305, "cannot use operator[] with a string argument with " + std::string(type_name()), *this));
}
- /*!
- @brief access specified object element with default value
-
- Returns either a copy of an object's element at the specified key @a key
- or a given default value if no element with key @a key exists.
-
- The function is basically equivalent to executing
- @code {.cpp}
- try {
- return at(key);
- } catch(out_of_range) {
- return default_value;
- }
- @endcode
-
- @note Unlike @ref at(const typename object_t::key_type&), this function
- does not throw if the given key @a key was not found.
-
- @note Unlike @ref operator[](const typename object_t::key_type& key), this
- function does not implicitly add an element to the position defined by @a
- key. This function is furthermore also applicable to const objects.
-
- @param[in] key key of the element to access
- @param[in] default_value the value to return if @a key is not found
-
- @tparam ValueType type compatible to JSON values, for instance `int` for
- JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
- JSON arrays. Note the type of the expected value at @a key and the default
- value @a default_value must be compatible.
-
- @return copy of the element at key @a key or @a default_value if @a key
- is not found
-
- @throw type_error.302 if @a default_value does not match the type of the
- value at @a key
- @throw type_error.306 if the JSON value is not an object; in that case,
- using `value()` with a key makes no sense.
-
- @complexity Logarithmic in the size of the container.
-
- @liveexample{The example below shows how object elements can be queried
- with a default value.,basic_json__value}
-
- @sa see @ref at(const typename object_t::key_type&) for access by reference
- with range checking
- @sa see @ref operator[](const typename object_t::key_type&) for unchecked
- access by reference
-
- @since version 1.0.0
- */
- // using std::is_convertible in a std::enable_if will fail when using explicit conversions
+ /// @brief access specified object element with default value
+ /// @sa https://json.nlohmann.me/api/basic_json/value/
+ /// using std::is_convertible in a std::enable_if will fail when using explicit conversions
template < class ValueType, typename std::enable_if <
detail::is_getable<basic_json_t, ValueType>::value
&& !std::is_same<value_t, ValueType>::value, int >::type = 0 >
@@ -21505,58 +19334,16 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(306, "cannot use value() with " + std::string(type_name()), *this));
}
- /*!
- @brief overload for a default value of type const char*
- @copydoc basic_json::value(const typename object_t::key_type&, const ValueType&) const
- */
+ /// @brief access specified object element with default value
+ /// @sa https://json.nlohmann.me/api/basic_json/value/
+ /// overload for a default value of type const char*
string_t value(const typename object_t::key_type& key, const char* default_value) const
{
return value(key, string_t(default_value));
}
- /*!
- @brief access specified object element via JSON Pointer with default value
-
- Returns either a copy of an object's element at the specified key @a key
- or a given default value if no element with key @a key exists.
-
- The function is basically equivalent to executing
- @code {.cpp}
- try {
- return at(ptr);
- } catch(out_of_range) {
- return default_value;
- }
- @endcode
-
- @note Unlike @ref at(const json_pointer&), this function does not throw
- if the given key @a key was not found.
-
- @param[in] ptr a JSON pointer to the element to access
- @param[in] default_value the value to return if @a ptr found no value
-
- @tparam ValueType type compatible to JSON values, for instance `int` for
- JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
- JSON arrays. Note the type of the expected value at @a key and the default
- value @a default_value must be compatible.
-
- @return copy of the element at key @a key or @a default_value if @a key
- is not found
-
- @throw type_error.302 if @a default_value does not match the type of the
- value at @a ptr
- @throw type_error.306 if the JSON value is not an object; in that case,
- using `value()` with a key makes no sense.
-
- @complexity Logarithmic in the size of the container.
-
- @liveexample{The example below shows how object elements can be queried
- with a default value.,basic_json__value_ptr}
-
- @sa see @ref operator[](const json_pointer&) for unchecked access by reference
-
- @since version 2.0.2
- */
+ /// @brief access specified object element via JSON Pointer with default value
+ /// @sa https://json.nlohmann.me/api/basic_json/value/
template<class ValueType, typename std::enable_if<
detail::is_getable<basic_json_t, ValueType>::value, int>::type = 0>
ValueType value(const json_pointer& ptr, const ValueType& default_value) const
@@ -21578,85 +19365,31 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(306, "cannot use value() with " + std::string(type_name()), *this));
}
- /*!
- @brief overload for a default value of type const char*
- @copydoc basic_json::value(const json_pointer&, ValueType) const
- */
+ /// @brief access specified object element via JSON Pointer with default value
+ /// @sa https://json.nlohmann.me/api/basic_json/value/
+ /// overload for a default value of type const char*
JSON_HEDLEY_NON_NULL(3)
string_t value(const json_pointer& ptr, const char* default_value) const
{
return value(ptr, string_t(default_value));
}
- /*!
- @brief access the first element
-
- Returns a reference to the first element in the container. For a JSON
- container `c`, the expression `c.front()` is equivalent to `*c.begin()`.
-
- @return In case of a structured type (array or object), a reference to the
- first element is returned. In case of number, string, boolean, or binary
- values, a reference to the value is returned.
-
- @complexity Constant.
-
- @pre The JSON value must not be `null` (would throw `std::out_of_range`)
- or an empty array or object (undefined behavior, **guarded by
- assertions**).
- @post The JSON value remains unchanged.
-
- @throw invalid_iterator.214 when called on `null` value
-
- @liveexample{The following code shows an example for `front()`.,front}
-
- @sa see @ref back() -- access the last element
-
- @since version 1.0.0
- */
+ /// @brief access the first element
+ /// @sa https://json.nlohmann.me/api/basic_json/front/
reference front()
{
return *begin();
}
- /*!
- @copydoc basic_json::front()
- */
+ /// @brief access the first element
+ /// @sa https://json.nlohmann.me/api/basic_json/front/
const_reference front() const
{
return *cbegin();
}
- /*!
- @brief access the last element
-
- Returns a reference to the last element in the container. For a JSON
- container `c`, the expression `c.back()` is equivalent to
- @code {.cpp}
- auto tmp = c.end();
- --tmp;
- return *tmp;
- @endcode
-
- @return In case of a structured type (array or object), a reference to the
- last element is returned. In case of number, string, boolean, or binary
- values, a reference to the value is returned.
-
- @complexity Constant.
-
- @pre The JSON value must not be `null` (would throw `std::out_of_range`)
- or an empty array or object (undefined behavior, **guarded by
- assertions**).
- @post The JSON value remains unchanged.
-
- @throw invalid_iterator.214 when called on a `null` value. See example
- below.
-
- @liveexample{The following code shows an example for `back()`.,back}
-
- @sa see @ref front() -- access the first element
-
- @since version 1.0.0
- */
+ /// @brief access the last element
+ /// @sa https://json.nlohmann.me/api/basic_json/back/
reference back()
{
auto tmp = end();
@@ -21664,9 +19397,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return *tmp;
}
- /*!
- @copydoc basic_json::back()
- */
+ /// @brief access the last element
+ /// @sa https://json.nlohmann.me/api/basic_json/back/
const_reference back() const
{
auto tmp = cend();
@@ -21674,52 +19406,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return *tmp;
}
- /*!
- @brief remove element given an iterator
-
- Removes the element specified by iterator @a pos. The iterator @a pos must
- be valid and dereferenceable. Thus the `end()` iterator (which is valid,
- but is not dereferenceable) cannot be used as a value for @a pos.
-
- If called on a primitive type other than `null`, the resulting JSON value
- will be `null`.
-
- @param[in] pos iterator to the element to remove
- @return Iterator following the last removed element. If the iterator @a
- pos refers to the last element, the `end()` iterator is returned.
-
- @tparam IteratorType an @ref iterator or @ref const_iterator
-
- @post Invalidates iterators and references at or after the point of the
- erase, including the `end()` iterator.
-
- @throw type_error.307 if called on a `null` value; example: `"cannot use
- erase() with null"`
- @throw invalid_iterator.202 if called on an iterator which does not belong
- to the current JSON value; example: `"iterator does not fit current
- value"`
- @throw invalid_iterator.205 if called on a primitive type with invalid
- iterator (i.e., any iterator which is not `begin()`); example: `"iterator
- out of range"`
-
- @complexity The complexity depends on the type:
- - objects: amortized constant
- - arrays: linear in distance between @a pos and the end of the container
- - strings and binary: linear in the length of the member
- - other types: constant
-
- @liveexample{The example shows the result of `erase()` for different JSON
- types.,erase__IteratorType}
-
- @sa see @ref erase(IteratorType, IteratorType) -- removes the elements in
- the given range
- @sa see @ref erase(const typename object_t::key_type&) -- removes the element
- from an object at the given key
- @sa see @ref erase(const size_type) -- removes the element from an array at
- the given index
-
- @since version 1.0.0
- */
+ /// @brief remove element given an iterator
+ /// @sa https://json.nlohmann.me/api/basic_json/erase/
template < class IteratorType, typename std::enable_if <
std::is_same<IteratorType, typename basic_json_t::iterator>::value ||
std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int >::type
@@ -21789,52 +19477,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief remove elements given an iterator range
-
- Removes the element specified by the range `[first; last)`. The iterator
- @a first does not need to be dereferenceable if `first == last`: erasing
- an empty range is a no-op.
-
- If called on a primitive type other than `null`, the resulting JSON value
- will be `null`.
-
- @param[in] first iterator to the beginning of the range to remove
- @param[in] last iterator past the end of the range to remove
- @return Iterator following the last removed element. If the iterator @a
- second refers to the last element, the `end()` iterator is returned.
-
- @tparam IteratorType an @ref iterator or @ref const_iterator
-
- @post Invalidates iterators and references at or after the point of the
- erase, including the `end()` iterator.
-
- @throw type_error.307 if called on a `null` value; example: `"cannot use
- erase() with null"`
- @throw invalid_iterator.203 if called on iterators which does not belong
- to the current JSON value; example: `"iterators do not fit current value"`
- @throw invalid_iterator.204 if called on a primitive type with invalid
- iterators (i.e., if `first != begin()` and `last != end()`); example:
- `"iterators out of range"`
-
- @complexity The complexity depends on the type:
- - objects: `log(size()) + std::distance(first, last)`
- - arrays: linear in the distance between @a first and @a last, plus linear
- in the distance between @a last and end of the container
- - strings and binary: linear in the length of the member
- - other types: constant
-
- @liveexample{The example shows the result of `erase()` for different JSON
- types.,erase__IteratorType_IteratorType}
-
- @sa see @ref erase(IteratorType) -- removes the element at a given position
- @sa see @ref erase(const typename object_t::key_type&) -- removes the element
- from an object at the given key
- @sa see @ref erase(const size_type) -- removes the element from an array at
- the given index
-
- @since version 1.0.0
- */
+ /// @brief remove elements given an iterator range
+ /// @sa https://json.nlohmann.me/api/basic_json/erase/
template < class IteratorType, typename std::enable_if <
std::is_same<IteratorType, typename basic_json_t::iterator>::value ||
std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int >::type
@@ -21907,35 +19551,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief remove element from a JSON object given a key
-
- Removes elements from a JSON object with the key value @a key.
-
- @param[in] key value of the elements to remove
-
- @return Number of elements removed. If @a ObjectType is the default
- `std::map` type, the return value will always be `0` (@a key was not
- found) or `1` (@a key was found).
-
- @post References and iterators to the erased elements are invalidated.
- Other references and iterators are not affected.
-
- @throw type_error.307 when called on a type other than JSON object;
- example: `"cannot use erase() with null"`
-
- @complexity `log(size()) + count(key)`
-
- @liveexample{The example shows the effect of `erase()`.,erase__key_type}
-
- @sa see @ref erase(IteratorType) -- removes the element at a given position
- @sa see @ref erase(IteratorType, IteratorType) -- removes the elements in
- the given range
- @sa see @ref erase(const size_type) -- removes the element from an array at
- the given index
-
- @since version 1.0.0
- */
+ /// @brief remove element from a JSON object given a key
+ /// @sa https://json.nlohmann.me/api/basic_json/erase/
size_type erase(const typename object_t::key_type& key)
{
// this erase only works for objects
@@ -21947,30 +19564,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(307, "cannot use erase() with " + std::string(type_name()), *this));
}
- /*!
- @brief remove element from a JSON array given an index
-
- Removes element from a JSON array at the index @a idx.
-
- @param[in] idx index of the element to remove
-
- @throw type_error.307 when called on a type other than JSON object;
- example: `"cannot use erase() with null"`
- @throw out_of_range.401 when `idx >= size()`; example: `"array index 17
- is out of range"`
-
- @complexity Linear in distance between @a idx and the end of the container.
-
- @liveexample{The example shows the effect of `erase()`.,erase__size_type}
-
- @sa see @ref erase(IteratorType) -- removes the element at a given position
- @sa see @ref erase(IteratorType, IteratorType) -- removes the elements in
- the given range
- @sa see @ref erase(const typename object_t::key_type&) -- removes the element
- from an object at the given key
-
- @since version 1.0.0
- */
+ /// @brief remove element from a JSON array given an index
+ /// @sa https://json.nlohmann.me/api/basic_json/erase/
void erase(const size_type idx)
{
// this erase only works for arrays
@@ -21999,30 +19594,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name lookup
/// @{
- /*!
- @brief find an element in a JSON object
-
- Finds an element in a JSON object with key equivalent to @a key. If the
- element is not found or the JSON value is not an object, end() is
- returned.
-
- @note This method always returns @ref end() when executed on a JSON type
- that is not an object.
-
- @param[in] key key value of the element to search for.
-
- @return Iterator to an element with key equivalent to @a key. If no such
- element is found or the JSON value is not an object, past-the-end (see
- @ref end()) iterator is returned.
-
- @complexity Logarithmic in the size of the JSON object.
-
- @liveexample{The example shows how `find()` is used.,find__key_type}
-
- @sa see @ref contains(KeyT&&) const -- checks whether a key exists
-
- @since version 1.0.0
- */
+ /// @brief find an element in a JSON object
+ /// @sa https://json.nlohmann.me/api/basic_json/find/
template<typename KeyT>
iterator find(KeyT&& key)
{
@@ -22036,10 +19609,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief find an element in a JSON object
- @copydoc find(KeyT&&)
- */
+ /// @brief find an element in a JSON object
+ /// @sa https://json.nlohmann.me/api/basic_json/find/
template<typename KeyT>
const_iterator find(KeyT&& key) const
{
@@ -22053,27 +19624,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief returns the number of occurrences of a key in a JSON object
-
- Returns the number of elements with key @a key. If ObjectType is the
- default `std::map` type, the return value will always be `0` (@a key was
- not found) or `1` (@a key was found).
-
- @note This method always returns `0` when executed on a JSON type that is
- not an object.
-
- @param[in] key key value of the element to count
-
- @return Number of elements with key @a key. If the JSON value is not an
- object, the return value will be `0`.
-
- @complexity Logarithmic in the size of the JSON object.
-
- @liveexample{The example shows how `count()` is used.,count}
-
- @since version 1.0.0
- */
+ /// @brief returns the number of occurrences of a key in a JSON object
+ /// @sa https://json.nlohmann.me/api/basic_json/count/
template<typename KeyT>
size_type count(KeyT&& key) const
{
@@ -22081,31 +19633,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return is_object() ? m_value.object->count(std::forward<KeyT>(key)) : 0;
}
- /*!
- @brief check the existence of an element in a JSON object
-
- Check whether an element exists in a JSON object with key equivalent to
- @a key. If the element is not found or the JSON value is not an object,
- false is returned.
-
- @note This method always returns false when executed on a JSON type
- that is not an object.
-
- @param[in] key key value to check its existence.
-
- @return true if an element with specified @a key exists. If no such
- element with such key is found or the JSON value is not an object,
- false is returned.
-
- @complexity Logarithmic in the size of the JSON object.
-
- @liveexample{The following code shows an example for `contains()`.,contains}
-
- @sa see @ref find(KeyT&&) -- returns an iterator to an object element
- @sa see @ref contains(const json_pointer&) const -- checks the existence for a JSON pointer
-
- @since version 3.6.0
- */
+ /// @brief check the existence of an element in a JSON object
+ /// @sa https://json.nlohmann.me/api/basic_json/contains/
template < typename KeyT, typename std::enable_if <
!std::is_same<typename std::decay<KeyT>::type, json_pointer>::value, int >::type = 0 >
bool contains(KeyT && key) const
@@ -22113,32 +19642,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return is_object() && m_value.object->find(std::forward<KeyT>(key)) != m_value.object->end();
}
- /*!
- @brief check the existence of an element in a JSON object given a JSON pointer
-
- Check whether the given JSON pointer @a ptr can be resolved in the current
- JSON value.
-
- @note This method can be executed on any JSON value type.
-
- @param[in] ptr JSON pointer to check its existence.
-
- @return true if the JSON pointer can be resolved to a stored value, false
- otherwise.
-
- @post If `j.contains(ptr)` returns true, it is safe to call `j[ptr]`.
-
- @throw parse_error.106 if an array index begins with '0'
- @throw parse_error.109 if an array index was not a number
-
- @complexity Logarithmic in the size of the JSON object.
-
- @liveexample{The following code shows an example for `contains()`.,contains_json_pointer}
-
- @sa see @ref contains(KeyT &&) const -- checks the existence of a key
-
- @since version 3.7.0
- */
+ /// @brief check the existence of an element in a JSON object given a JSON pointer
+ /// @sa https://json.nlohmann.me/api/basic_json/contains/
bool contains(const json_pointer& ptr) const
{
return ptr.contains(this);
@@ -22154,30 +19659,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name iterators
/// @{
- /*!
- @brief returns an iterator to the first element
-
- Returns an iterator to the first element.
-
- @image html range-begin-end.svg "Illustration from cppreference.com"
-
- @return iterator to the first element
-
- @complexity Constant.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is constant.
-
- @liveexample{The following code shows an example for `begin()`.,begin}
-
- @sa see @ref cbegin() -- returns a const iterator to the beginning
- @sa see @ref end() -- returns an iterator to the end
- @sa see @ref cend() -- returns a const iterator to the end
-
- @since version 1.0.0
- */
+ /// @brief returns an iterator to the first element
+ /// @sa https://json.nlohmann.me/api/basic_json/begin/
iterator begin() noexcept
{
iterator result(this);
@@ -22185,39 +19668,15 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @copydoc basic_json::cbegin()
- */
+ /// @brief returns an iterator to the first element
+ /// @sa https://json.nlohmann.me/api/basic_json/begin/
const_iterator begin() const noexcept
{
return cbegin();
}
- /*!
- @brief returns a const iterator to the first element
-
- Returns a const iterator to the first element.
-
- @image html range-begin-end.svg "Illustration from cppreference.com"
-
- @return const iterator to the first element
-
- @complexity Constant.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is constant.
- - Has the semantics of `const_cast<const basic_json&>(*this).begin()`.
-
- @liveexample{The following code shows an example for `cbegin()`.,cbegin}
-
- @sa see @ref begin() -- returns an iterator to the beginning
- @sa see @ref end() -- returns an iterator to the end
- @sa see @ref cend() -- returns a const iterator to the end
-
- @since version 1.0.0
- */
+ /// @brief returns a const iterator to the first element
+ /// @sa https://json.nlohmann.me/api/basic_json/cbegin/
const_iterator cbegin() const noexcept
{
const_iterator result(this);
@@ -22225,30 +19684,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief returns an iterator to one past the last element
-
- Returns an iterator to one past the last element.
-
- @image html range-begin-end.svg "Illustration from cppreference.com"
-
- @return iterator one past the last element
-
- @complexity Constant.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is constant.
-
- @liveexample{The following code shows an example for `end()`.,end}
-
- @sa see @ref cend() -- returns a const iterator to the end
- @sa see @ref begin() -- returns an iterator to the beginning
- @sa see @ref cbegin() -- returns a const iterator to the beginning
-
- @since version 1.0.0
- */
+ /// @brief returns an iterator to one past the last element
+ /// @sa https://json.nlohmann.me/api/basic_json/end/
iterator end() noexcept
{
iterator result(this);
@@ -22256,39 +19693,15 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @copydoc basic_json::cend()
- */
+ /// @brief returns an iterator to one past the last element
+ /// @sa https://json.nlohmann.me/api/basic_json/end/
const_iterator end() const noexcept
{
return cend();
}
- /*!
- @brief returns a const iterator to one past the last element
-
- Returns a const iterator to one past the last element.
-
- @image html range-begin-end.svg "Illustration from cppreference.com"
-
- @return const iterator one past the last element
-
- @complexity Constant.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is constant.
- - Has the semantics of `const_cast<const basic_json&>(*this).end()`.
-
- @liveexample{The following code shows an example for `cend()`.,cend}
-
- @sa see @ref end() -- returns an iterator to the end
- @sa see @ref begin() -- returns an iterator to the beginning
- @sa see @ref cbegin() -- returns a const iterator to the beginning
-
- @since version 1.0.0
- */
+ /// @brief returns an iterator to one past the last element
+ /// @sa https://json.nlohmann.me/api/basic_json/cend/
const_iterator cend() const noexcept
{
const_iterator result(this);
@@ -22296,286 +19709,80 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief returns an iterator to the reverse-beginning
-
- Returns an iterator to the reverse-beginning; that is, the last element.
-
- @image html range-rbegin-rend.svg "Illustration from cppreference.com"
-
- @complexity Constant.
-
- @requirement This function helps `basic_json` satisfying the
- [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer)
- requirements:
- - The complexity is constant.
- - Has the semantics of `reverse_iterator(end())`.
-
- @liveexample{The following code shows an example for `rbegin()`.,rbegin}
-
- @sa see @ref crbegin() -- returns a const reverse iterator to the beginning
- @sa see @ref rend() -- returns a reverse iterator to the end
- @sa see @ref crend() -- returns a const reverse iterator to the end
-
- @since version 1.0.0
- */
+ /// @brief returns an iterator to the reverse-beginning
+ /// @sa https://json.nlohmann.me/api/basic_json/rbegin/
reverse_iterator rbegin() noexcept
{
return reverse_iterator(end());
}
- /*!
- @copydoc basic_json::crbegin()
- */
+ /// @brief returns an iterator to the reverse-beginning
+ /// @sa https://json.nlohmann.me/api/basic_json/rbegin/
const_reverse_iterator rbegin() const noexcept
{
return crbegin();
}
- /*!
- @brief returns an iterator to the reverse-end
-
- Returns an iterator to the reverse-end; that is, one before the first
- element.
-
- @image html range-rbegin-rend.svg "Illustration from cppreference.com"
-
- @complexity Constant.
-
- @requirement This function helps `basic_json` satisfying the
- [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer)
- requirements:
- - The complexity is constant.
- - Has the semantics of `reverse_iterator(begin())`.
-
- @liveexample{The following code shows an example for `rend()`.,rend}
-
- @sa see @ref crend() -- returns a const reverse iterator to the end
- @sa see @ref rbegin() -- returns a reverse iterator to the beginning
- @sa see @ref crbegin() -- returns a const reverse iterator to the beginning
-
- @since version 1.0.0
- */
+ /// @brief returns an iterator to the reverse-end
+ /// @sa https://json.nlohmann.me/api/basic_json/rend/
reverse_iterator rend() noexcept
{
return reverse_iterator(begin());
}
- /*!
- @copydoc basic_json::crend()
- */
+ /// @brief returns an iterator to the reverse-end
+ /// @sa https://json.nlohmann.me/api/basic_json/rend/
const_reverse_iterator rend() const noexcept
{
return crend();
}
- /*!
- @brief returns a const reverse iterator to the last element
-
- Returns a const iterator to the reverse-beginning; that is, the last
- element.
-
- @image html range-rbegin-rend.svg "Illustration from cppreference.com"
-
- @complexity Constant.
-
- @requirement This function helps `basic_json` satisfying the
- [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer)
- requirements:
- - The complexity is constant.
- - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.
-
- @liveexample{The following code shows an example for `crbegin()`.,crbegin}
-
- @sa see @ref rbegin() -- returns a reverse iterator to the beginning
- @sa see @ref rend() -- returns a reverse iterator to the end
- @sa see @ref crend() -- returns a const reverse iterator to the end
-
- @since version 1.0.0
- */
+ /// @brief returns a const reverse iterator to the last element
+ /// @sa https://json.nlohmann.me/api/basic_json/crbegin/
const_reverse_iterator crbegin() const noexcept
{
return const_reverse_iterator(cend());
}
- /*!
- @brief returns a const reverse iterator to one before the first
-
- Returns a const reverse iterator to the reverse-end; that is, one before
- the first element.
-
- @image html range-rbegin-rend.svg "Illustration from cppreference.com"
-
- @complexity Constant.
-
- @requirement This function helps `basic_json` satisfying the
- [ReversibleContainer](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer)
- requirements:
- - The complexity is constant.
- - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.
-
- @liveexample{The following code shows an example for `crend()`.,crend}
-
- @sa see @ref rend() -- returns a reverse iterator to the end
- @sa see @ref rbegin() -- returns a reverse iterator to the beginning
- @sa see @ref crbegin() -- returns a const reverse iterator to the beginning
-
- @since version 1.0.0
- */
+ /// @brief returns a const reverse iterator to one before the first
+ /// @sa https://json.nlohmann.me/api/basic_json/crend/
const_reverse_iterator crend() const noexcept
{
return const_reverse_iterator(cbegin());
}
public:
- /*!
- @brief wrapper to access iterator member functions in range-based for
-
- This function allows to access @ref iterator::key() and @ref
- iterator::value() during range-based for loops. In these loops, a
- reference to the JSON values is returned, so there is no access to the
- underlying iterator.
-
- For loop without iterator_wrapper:
-
- @code{cpp}
- for (auto it = j_object.begin(); it != j_object.end(); ++it)
- {
- std::cout << "key: " << it.key() << ", value:" << it.value() << '\n';
- }
- @endcode
-
- Range-based for loop without iterator proxy:
-
- @code{cpp}
- for (auto it : j_object)
- {
- // "it" is of type json::reference and has no key() member
- std::cout << "value: " << it << '\n';
- }
- @endcode
-
- Range-based for loop with iterator proxy:
-
- @code{cpp}
- for (auto it : json::iterator_wrapper(j_object))
- {
- std::cout << "key: " << it.key() << ", value:" << it.value() << '\n';
- }
- @endcode
-
- @note When iterating over an array, `key()` will return the index of the
- element as string (see example).
-
- @param[in] ref reference to a JSON value
- @return iteration proxy object wrapping @a ref with an interface to use in
- range-based for loops
-
- @liveexample{The following code shows how the wrapper is used,iterator_wrapper}
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @complexity Constant.
-
- @note The name of this function is not yet final and may change in the
- future.
-
- @deprecated This stream operator is deprecated and will be removed in
- future 4.0.0 of the library. Please use @ref items() instead;
- that is, replace `json::iterator_wrapper(j)` with `j.items()`.
- */
+ /// @brief wrapper to access iterator member functions in range-based for
+ /// @sa https://json.nlohmann.me/api/basic_json/items/
+ /// @deprecated This function is deprecated since 3.1.0 and will be removed in
+ /// version 4.0.0 of the library. Please use @ref items() instead;
+ /// that is, replace `json::iterator_wrapper(j)` with `j.items()`.
JSON_HEDLEY_DEPRECATED_FOR(3.1.0, items())
static iteration_proxy<iterator> iterator_wrapper(reference ref) noexcept
{
return ref.items();
}
- /*!
- @copydoc iterator_wrapper(reference)
- */
+ /// @brief wrapper to access iterator member functions in range-based for
+ /// @sa https://json.nlohmann.me/api/basic_json/items/
+ /// @deprecated This function is deprecated since 3.1.0 and will be removed in
+ /// version 4.0.0 of the library. Please use @ref items() instead;
+ /// that is, replace `json::iterator_wrapper(j)` with `j.items()`.
JSON_HEDLEY_DEPRECATED_FOR(3.1.0, items())
static iteration_proxy<const_iterator> iterator_wrapper(const_reference ref) noexcept
{
return ref.items();
}
- /*!
- @brief helper to access iterator member functions in range-based for
-
- This function allows to access @ref iterator::key() and @ref
- iterator::value() during range-based for loops. In these loops, a
- reference to the JSON values is returned, so there is no access to the
- underlying iterator.
-
- For loop without `items()` function:
-
- @code{cpp}
- for (auto it = j_object.begin(); it != j_object.end(); ++it)
- {
- std::cout << "key: " << it.key() << ", value:" << it.value() << '\n';
- }
- @endcode
-
- Range-based for loop without `items()` function:
-
- @code{cpp}
- for (auto it : j_object)
- {
- // "it" is of type json::reference and has no key() member
- std::cout << "value: " << it << '\n';
- }
- @endcode
-
- Range-based for loop with `items()` function:
-
- @code{cpp}
- for (auto& el : j_object.items())
- {
- std::cout << "key: " << el.key() << ", value:" << el.value() << '\n';
- }
- @endcode
-
- The `items()` function also allows to use
- [structured bindings](https://en.cppreference.com/w/cpp/language/structured_binding)
- (C++17):
-
- @code{cpp}
- for (auto& [key, val] : j_object.items())
- {
- std::cout << "key: " << key << ", value:" << val << '\n';
- }
- @endcode
-
- @note When iterating over an array, `key()` will return the index of the
- element as string (see example). For primitive types (e.g., numbers),
- `key()` returns an empty string.
-
- @warning Using `items()` on temporary objects is dangerous. Make sure the
- object's lifetime exeeds the iteration. See
- <https://github.com/nlohmann/json/issues/2040> for more
- information.
-
- @return iteration proxy object wrapping @a ref with an interface to use in
- range-based for loops
-
- @liveexample{The following code shows how the function is used.,items}
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @complexity Constant.
-
- @since version 3.1.0, structured bindings support since 3.5.0.
- */
+ /// @brief helper to access iterator member functions in range-based for
+ /// @sa https://json.nlohmann.me/api/basic_json/items/
iteration_proxy<iterator> items() noexcept
{
return iteration_proxy<iterator>(*this);
}
- /*!
- @copydoc items()
- */
+ /// @brief helper to access iterator member functions in range-based for
+ /// @sa https://json.nlohmann.me/api/basic_json/items/
iteration_proxy<const_iterator> items() const noexcept
{
return iteration_proxy<const_iterator>(*this);
@@ -22591,48 +19798,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name capacity
/// @{
- /*!
- @brief checks whether the container is empty.
-
- Checks if a JSON value has no elements (i.e. whether its @ref size is `0`).
-
- @return The return value depends on the different types and is
- defined as follows:
- Value type | return value
- ----------- | -------------
- null | `true`
- boolean | `false`
- string | `false`
- number | `false`
- binary | `false`
- object | result of function `object_t::empty()`
- array | result of function `array_t::empty()`
-
- @liveexample{The following code uses `empty()` to check if a JSON
- object contains any elements.,empty}
-
- @complexity Constant, as long as @ref array_t and @ref object_t satisfy
- the Container concept; that is, their `empty()` functions have constant
- complexity.
-
- @iterators No changes.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @note This function does not return whether a string stored as JSON value
- is empty - it returns whether the JSON container itself is empty which is
- false in the case of a string.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is constant.
- - Has the semantics of `begin() == end()`.
-
- @sa see @ref size() -- returns the number of elements
-
- @since version 1.0.0
- */
+ /// @brief checks whether the container is empty.
+ /// @sa https://json.nlohmann.me/api/basic_json/empty/
bool empty() const noexcept
{
switch (m_type)
@@ -22670,49 +19837,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief returns the number of elements
-
- Returns the number of elements in a JSON value.
-
- @return The return value depends on the different types and is
- defined as follows:
- Value type | return value
- ----------- | -------------
- null | `0`
- boolean | `1`
- string | `1`
- number | `1`
- binary | `1`
- object | result of function object_t::size()
- array | result of function array_t::size()
-
- @liveexample{The following code calls `size()` on the different value
- types.,size}
-
- @complexity Constant, as long as @ref array_t and @ref object_t satisfy
- the Container concept; that is, their size() functions have constant
- complexity.
-
- @iterators No changes.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @note This function does not return the length of a string stored as JSON
- value - it returns the number of elements in the JSON value which is 1 in
- the case of a string.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is constant.
- - Has the semantics of `std::distance(begin(), end())`.
-
- @sa see @ref empty() -- checks whether the container is empty
- @sa see @ref max_size() -- returns the maximal number of elements
-
- @since version 1.0.0
- */
+ /// @brief returns the number of elements
+ /// @sa https://json.nlohmann.me/api/basic_json/size/
size_type size() const noexcept
{
switch (m_type)
@@ -22750,47 +19876,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief returns the maximum possible number of elements
-
- Returns the maximum number of elements a JSON value is able to hold due to
- system or library implementation limitations, i.e. `std::distance(begin(),
- end())` for the JSON value.
-
- @return The return value depends on the different types and is
- defined as follows:
- Value type | return value
- ----------- | -------------
- null | `0` (same as `size()`)
- boolean | `1` (same as `size()`)
- string | `1` (same as `size()`)
- number | `1` (same as `size()`)
- binary | `1` (same as `size()`)
- object | result of function `object_t::max_size()`
- array | result of function `array_t::max_size()`
-
- @liveexample{The following code calls `max_size()` on the different value
- types. Note the output is implementation specific.,max_size}
-
- @complexity Constant, as long as @ref array_t and @ref object_t satisfy
- the Container concept; that is, their `max_size()` functions have constant
- complexity.
-
- @iterators No changes.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @requirement This function helps `basic_json` satisfying the
- [Container](https://en.cppreference.com/w/cpp/named_req/Container)
- requirements:
- - The complexity is constant.
- - Has the semantics of returning `b.size()` where `b` is the largest
- possible JSON value.
-
- @sa see @ref size() -- returns the number of elements
-
- @since version 1.0.0
- */
+ /// @brief returns the maximum possible number of elements
+ /// @sa https://json.nlohmann.me/api/basic_json/max_size/
size_type max_size() const noexcept
{
switch (m_type)
@@ -22833,43 +19920,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name modifiers
/// @{
- /*!
- @brief clears the contents
-
- Clears the content of a JSON value and resets it to the default value as
- if @ref basic_json(value_t) would have been called with the current value
- type from @ref type():
-
- Value type | initial value
- ----------- | -------------
- null | `null`
- boolean | `false`
- string | `""`
- number | `0`
- binary | An empty byte vector
- object | `{}`
- array | `[]`
-
- @post Has the same effect as calling
- @code {.cpp}
- *this = basic_json(type());
- @endcode
-
- @liveexample{The example below shows the effect of `clear()` to different
- JSON types.,clear}
-
- @complexity Linear in the size of the JSON value.
-
- @iterators All iterators, pointers and references related to this container
- are invalidated.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @sa see @ref basic_json(value_t) -- constructor that creates an object with the
- same value than calling `clear()`
-
- @since version 1.0.0
- */
+ /// @brief clears the contents
+ /// @sa https://json.nlohmann.me/api/basic_json/clear/
void clear() noexcept
{
switch (m_type)
@@ -22929,26 +19981,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief add an object to an array
-
- Appends the given element @a val to the end of the JSON value. If the
- function is called on a JSON null value, an empty array is created before
- appending @a val.
-
- @param[in] val the value to add to the JSON array
-
- @throw type_error.308 when called on a type other than JSON array or
- null; example: `"cannot use push_back() with number"`
-
- @complexity Amortized constant.
-
- @liveexample{The example shows how `push_back()` and `+=` can be used to
- add elements to a JSON array. Note how the `null` value was silently
- converted to a JSON array.,push_back}
-
- @since version 1.0.0
- */
+ /// @brief add an object to an array
+ /// @sa https://json.nlohmann.me/api/basic_json/push_back/
void push_back(basic_json&& val)
{
// push_back only works for null objects or arrays
@@ -22969,23 +20003,19 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
const auto old_capacity = m_value.array->capacity();
m_value.array->push_back(std::move(val));
set_parent(m_value.array->back(), old_capacity);
- // if val is moved from, basic_json move constructor marks it null so we do not call the destructor
+ // if val is moved from, basic_json move constructor marks it null, so we do not call the destructor
}
- /*!
- @brief add an object to an array
- @copydoc push_back(basic_json&&)
- */
+ /// @brief add an object to an array
+ /// @sa https://json.nlohmann.me/api/basic_json/operator+=/
reference operator+=(basic_json&& val)
{
push_back(std::move(val));
return *this;
}
- /*!
- @brief add an object to an array
- @copydoc push_back(basic_json&&)
- */
+ /// @brief add an object to an array
+ /// @sa https://json.nlohmann.me/api/basic_json/push_back/
void push_back(const basic_json& val)
{
// push_back only works for null objects or arrays
@@ -23008,36 +20038,16 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
set_parent(m_value.array->back(), old_capacity);
}
- /*!
- @brief add an object to an array
- @copydoc push_back(basic_json&&)
- */
+ /// @brief add an object to an array
+ /// @sa https://json.nlohmann.me/api/basic_json/operator+=/
reference operator+=(const basic_json& val)
{
push_back(val);
return *this;
}
- /*!
- @brief add an object to an object
-
- Inserts the given element @a val to the JSON object. If the function is
- called on a JSON null value, an empty object is created before inserting
- @a val.
-
- @param[in] val the value to add to the JSON object
-
- @throw type_error.308 when called on a type other than JSON object or
- null; example: `"cannot use push_back() with number"`
-
- @complexity Logarithmic in the size of the container, O(log(`size()`)).
-
- @liveexample{The example shows how `push_back()` and `+=` can be used to
- add elements to a JSON object. Note how the `null` value was silently
- converted to a JSON object.,push_back__object_t__value}
-
- @since version 1.0.0
- */
+ /// @brief add an object to an object
+ /// @sa https://json.nlohmann.me/api/basic_json/push_back/
void push_back(const typename object_t::value_type& val)
{
// push_back only works for null objects or objects
@@ -23059,41 +20069,16 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
set_parent(res.first->second);
}
- /*!
- @brief add an object to an object
- @copydoc push_back(const typename object_t::value_type&)
- */
+ /// @brief add an object to an object
+ /// @sa https://json.nlohmann.me/api/basic_json/operator+=/
reference operator+=(const typename object_t::value_type& val)
{
push_back(val);
return *this;
}
- /*!
- @brief add an object to an object
-
- This function allows to use `push_back` with an initializer list. In case
-
- 1. the current value is an object,
- 2. the initializer list @a init contains only two elements, and
- 3. the first element of @a init is a string,
-
- @a init is converted into an object element and added using
- @ref push_back(const typename object_t::value_type&). Otherwise, @a init
- is converted to a JSON value and added using @ref push_back(basic_json&&).
-
- @param[in] init an initializer list
-
- @complexity Linear in the size of the initializer list @a init.
-
- @note This function is required to resolve an ambiguous overload error,
- because pairs like `{"key", "value"}` can be both interpreted as
- `object_t::value_type` or `std::initializer_list<basic_json>`, see
- https://github.com/nlohmann/json/issues/235 for more information.
-
- @liveexample{The example shows how initializer lists are treated as
- objects when possible.,push_back__initializer_list}
- */
+ /// @brief add an object to an object
+ /// @sa https://json.nlohmann.me/api/basic_json/push_back/
void push_back(initializer_list_t init)
{
if (is_object() && init.size() == 2 && (*init.begin())->is_string())
@@ -23108,39 +20093,16 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief add an object to an object
- @copydoc push_back(initializer_list_t)
- */
+ /// @brief add an object to an object
+ /// @sa https://json.nlohmann.me/api/basic_json/operator+=/
reference operator+=(initializer_list_t init)
{
push_back(init);
return *this;
}
- /*!
- @brief add an object to an array
-
- Creates a JSON value from the passed parameters @a args to the end of the
- JSON value. If the function is called on a JSON null value, an empty array
- is created before appending the value created from @a args.
-
- @param[in] args arguments to forward to a constructor of @ref basic_json
- @tparam Args compatible types to create a @ref basic_json object
-
- @return reference to the inserted element
-
- @throw type_error.311 when called on a type other than JSON array or
- null; example: `"cannot use emplace_back() with number"`
-
- @complexity Amortized constant.
-
- @liveexample{The example shows how `push_back()` can be used to add
- elements to a JSON array. Note how the `null` value was silently converted
- to a JSON array.,emplace_back}
-
- @since version 2.0.8, returns reference since 3.7.0
- */
+ /// @brief add an object to an array
+ /// @sa https://json.nlohmann.me/api/basic_json/emplace_back/
template<class... Args>
reference emplace_back(Args&& ... args)
{
@@ -23164,33 +20126,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return set_parent(m_value.array->back(), old_capacity);
}
- /*!
- @brief add an object to an object if key does not exist
-
- Inserts a new element into a JSON object constructed in-place with the
- given @a args if there is no element with the key in the container. If the
- function is called on a JSON null value, an empty object is created before
- appending the value created from @a args.
-
- @param[in] args arguments to forward to a constructor of @ref basic_json
- @tparam Args compatible types to create a @ref basic_json object
-
- @return a pair consisting of an iterator to the inserted element, or the
- already-existing element if no insertion happened, and a bool
- denoting whether the insertion took place.
-
- @throw type_error.311 when called on a type other than JSON object or
- null; example: `"cannot use emplace() with number"`
-
- @complexity Logarithmic in the size of the container, O(log(`size()`)).
-
- @liveexample{The example shows how `emplace()` can be used to add elements
- to a JSON object. Note how the `null` value was silently converted to a
- JSON object. Further note how no value is added if there was already one
- value stored with the same key.,emplace}
-
- @since version 2.0.8
- */
+ /// @brief add an object to an object if key does not exist
+ /// @sa https://json.nlohmann.me/api/basic_json/emplace/
template<class... Args>
std::pair<iterator, bool> emplace(Args&& ... args)
{
@@ -23241,28 +20178,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief inserts element
-
- Inserts element @a val before iterator @a pos.
-
- @param[in] pos iterator before which the content will be inserted; may be
- the end() iterator
- @param[in] val element to insert
- @return iterator pointing to the inserted @a val.
-
- @throw type_error.309 if called on JSON values other than arrays;
- example: `"cannot use insert() with string"`
- @throw invalid_iterator.202 if @a pos is not an iterator of *this;
- example: `"iterator does not fit current value"`
-
- @complexity Constant plus linear in the distance between @a pos and end of
- the container.
-
- @liveexample{The example shows how `insert()` is used.,insert}
-
- @since version 1.0.0
- */
+ /// @brief inserts element into array
+ /// @sa https://json.nlohmann.me/api/basic_json/insert/
iterator insert(const_iterator pos, const basic_json& val)
{
// insert only works for arrays
@@ -23281,39 +20198,15 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()), *this));
}
- /*!
- @brief inserts element
- @copydoc insert(const_iterator, const basic_json&)
- */
+ /// @brief inserts element into array
+ /// @sa https://json.nlohmann.me/api/basic_json/insert/
iterator insert(const_iterator pos, basic_json&& val)
{
return insert(pos, val);
}
- /*!
- @brief inserts elements
-
- Inserts @a cnt copies of @a val before iterator @a pos.
-
- @param[in] pos iterator before which the content will be inserted; may be
- the end() iterator
- @param[in] cnt number of copies of @a val to insert
- @param[in] val element to insert
- @return iterator pointing to the first element inserted, or @a pos if
- `cnt==0`
-
- @throw type_error.309 if called on JSON values other than arrays; example:
- `"cannot use insert() with string"`
- @throw invalid_iterator.202 if @a pos is not an iterator of *this;
- example: `"iterator does not fit current value"`
-
- @complexity Linear in @a cnt plus linear in the distance between @a pos
- and end of the container.
-
- @liveexample{The example shows how `insert()` is used.,insert__count}
-
- @since version 1.0.0
- */
+ /// @brief inserts copies of element into array
+ /// @sa https://json.nlohmann.me/api/basic_json/insert/
iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
{
// insert only works for arrays
@@ -23332,36 +20225,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
JSON_THROW(type_error::create(309, "cannot use insert() with " + std::string(type_name()), *this));
}
- /*!
- @brief inserts elements
-
- Inserts elements from range `[first, last)` before iterator @a pos.
-
- @param[in] pos iterator before which the content will be inserted; may be
- the end() iterator
- @param[in] first begin of the range of elements to insert
- @param[in] last end of the range of elements to insert
-
- @throw type_error.309 if called on JSON values other than arrays; example:
- `"cannot use insert() with string"`
- @throw invalid_iterator.202 if @a pos is not an iterator of *this;
- example: `"iterator does not fit current value"`
- @throw invalid_iterator.210 if @a first and @a last do not belong to the
- same JSON value; example: `"iterators do not fit"`
- @throw invalid_iterator.211 if @a first or @a last are iterators into
- container for which insert is called; example: `"passed iterators may not
- belong to container"`
-
- @return iterator pointing to the first element inserted, or @a pos if
- `first==last`
-
- @complexity Linear in `std::distance(first, last)` plus linear in the
- distance between @a pos and end of the container.
-
- @liveexample{The example shows how `insert()` is used.,insert__range}
-
- @since version 1.0.0
- */
+ /// @brief inserts range of elements into array
+ /// @sa https://json.nlohmann.me/api/basic_json/insert/
iterator insert(const_iterator pos, const_iterator first, const_iterator last)
{
// insert only works for arrays
@@ -23391,30 +20256,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return insert_iterator(pos, first.m_it.array_iterator, last.m_it.array_iterator);
}
- /*!
- @brief inserts elements
-
- Inserts elements from initializer list @a ilist before iterator @a pos.
-
- @param[in] pos iterator before which the content will be inserted; may be
- the end() iterator
- @param[in] ilist initializer list to insert the values from
-
- @throw type_error.309 if called on JSON values other than arrays; example:
- `"cannot use insert() with string"`
- @throw invalid_iterator.202 if @a pos is not an iterator of *this;
- example: `"iterator does not fit current value"`
-
- @return iterator pointing to the first element inserted, or @a pos if
- `ilist` is empty
-
- @complexity Linear in `ilist.size()` plus linear in the distance between
- @a pos and end of the container.
-
- @liveexample{The example shows how `insert()` is used.,insert__ilist}
-
- @since version 1.0.0
- */
+ /// @brief inserts elements from initializer list into array
+ /// @sa https://json.nlohmann.me/api/basic_json/insert/
iterator insert(const_iterator pos, initializer_list_t ilist)
{
// insert only works for arrays
@@ -23433,29 +20276,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return insert_iterator(pos, ilist.begin(), ilist.end());
}
- /*!
- @brief inserts elements
-
- Inserts elements from range `[first, last)`.
-
- @param[in] first begin of the range of elements to insert
- @param[in] last end of the range of elements to insert
-
- @throw type_error.309 if called on JSON values other than objects; example:
- `"cannot use insert() with string"`
- @throw invalid_iterator.202 if iterator @a first or @a last does does not
- point to an object; example: `"iterators first and last must point to
- objects"`
- @throw invalid_iterator.210 if @a first and @a last do not belong to the
- same JSON value; example: `"iterators do not fit"`
-
- @complexity Logarithmic: `O(N*log(size() + N))`, where `N` is the number
- of elements to insert.
-
- @liveexample{The example shows how `insert()` is used.,insert__range_object}
-
- @since version 3.0.0
- */
+ /// @brief inserts range of elements into object
+ /// @sa https://json.nlohmann.me/api/basic_json/insert/
void insert(const_iterator first, const_iterator last)
{
// insert only works for objects
@@ -23479,80 +20301,16 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
m_value.object->insert(first.m_it.object_iterator, last.m_it.object_iterator);
}
- /*!
- @brief updates a JSON object from another object, overwriting existing keys
-
- Inserts all values from JSON object @a j and overwrites existing keys.
-
- @param[in] j JSON object to read values from
-
- @throw type_error.312 if called on JSON values other than objects; example:
- `"cannot use update() with string"`
-
- @complexity O(N*log(size() + N)), where N is the number of elements to
- insert.
-
- @liveexample{The example shows how `update()` is used.,update}
-
- @sa https://docs.python.org/3.6/library/stdtypes.html#dict.update
-
- @since version 3.0.0
- */
- void update(const_reference j)
+ /// @brief updates a JSON object from another object, overwriting existing keys
+ /// @sa https://json.nlohmann.me/api/basic_json/update/
+ void update(const_reference j, bool merge_objects = false)
{
- // implicitly convert null value to an empty object
- if (is_null())
- {
- m_type = value_t::object;
- m_value.object = create<object_t>();
- assert_invariant();
- }
-
- if (JSON_HEDLEY_UNLIKELY(!is_object()))
- {
- JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(type_name()), *this));
- }
- if (JSON_HEDLEY_UNLIKELY(!j.is_object()))
- {
- JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(j.type_name()), *this));
- }
-
- for (auto it = j.cbegin(); it != j.cend(); ++it)
- {
- m_value.object->operator[](it.key()) = it.value();
-#if JSON_DIAGNOSTICS
- m_value.object->operator[](it.key()).m_parent = this;
-#endif
- }
+ update(j.begin(), j.end(), merge_objects);
}
- /*!
- @brief updates a JSON object from another object, overwriting existing keys
-
- Inserts all values from from range `[first, last)` and overwrites existing
- keys.
-
- @param[in] first begin of the range of elements to insert
- @param[in] last end of the range of elements to insert
-
- @throw type_error.312 if called on JSON values other than objects; example:
- `"cannot use update() with string"`
- @throw invalid_iterator.202 if iterator @a first or @a last does does not
- point to an object; example: `"iterators first and last must point to
- objects"`
- @throw invalid_iterator.210 if @a first and @a last do not belong to the
- same JSON value; example: `"iterators do not fit"`
-
- @complexity O(N*log(size() + N)), where N is the number of elements to
- insert.
-
- @liveexample{The example shows how `update()` is used__range.,update}
-
- @sa https://docs.python.org/3.6/library/stdtypes.html#dict.update
-
- @since version 3.0.0
- */
- void update(const_iterator first, const_iterator last)
+ /// @brief updates a JSON object from another object, overwriting existing keys
+ /// @sa https://json.nlohmann.me/api/basic_json/update/
+ void update(const_iterator first, const_iterator last, bool merge_objects = false)
{
// implicitly convert null value to an empty object
if (is_null())
@@ -23574,14 +20332,22 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
// passed iterators must belong to objects
- if (JSON_HEDLEY_UNLIKELY(!first.m_object->is_object()
- || !last.m_object->is_object()))
+ if (JSON_HEDLEY_UNLIKELY(!first.m_object->is_object()))
{
- JSON_THROW(invalid_iterator::create(202, "iterators first and last must point to objects", *this));
+ JSON_THROW(type_error::create(312, "cannot use update() with " + std::string(first.m_object->type_name()), *first.m_object));
}
for (auto it = first; it != last; ++it)
{
+ if (merge_objects && it.value().is_object())
+ {
+ auto it2 = m_value.object->find(it.key());
+ if (it2 != m_value.object->end())
+ {
+ it2->second.update(it.value(), true);
+ continue;
+ }
+ }
m_value.object->operator[](it.key()) = it.value();
#if JSON_DIAGNOSTICS
m_value.object->operator[](it.key()).m_parent = this;
@@ -23589,23 +20355,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief exchanges the values
-
- Exchanges the contents of the JSON value with those of @a other. Does not
- invoke any move, copy, or swap operations on individual elements. All
- iterators and references remain valid. The past-the-end iterator is
- invalidated.
-
- @param[in,out] other JSON value to exchange the contents with
-
- @complexity Constant.
-
- @liveexample{The example below shows how JSON values can be swapped with
- `swap()`.,swap__reference}
-
- @since version 1.0.0
- */
+ /// @brief exchanges the values
+ /// @sa https://json.nlohmann.me/api/basic_json/swap/
void swap(reference other) noexcept (
std::is_nothrow_move_constructible<value_t>::value&&
std::is_nothrow_move_assignable<value_t>::value&&
@@ -23621,24 +20372,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
assert_invariant();
}
- /*!
- @brief exchanges the values
-
- Exchanges the contents of the JSON value from @a left with those of @a right. Does not
- invoke any move, copy, or swap operations on individual elements. All
- iterators and references remain valid. The past-the-end iterator is
- invalidated. implemented as a friend function callable via ADL.
-
- @param[in,out] left JSON value to exchange the contents with
- @param[in,out] right JSON value to exchange the contents with
-
- @complexity Constant.
-
- @liveexample{The example below shows how JSON values can be swapped with
- `swap()`.,swap__reference}
-
- @since version 1.0.0
- */
+ /// @brief exchanges the values
+ /// @sa https://json.nlohmann.me/api/basic_json/swap/
friend void swap(reference left, reference right) noexcept (
std::is_nothrow_move_constructible<value_t>::value&&
std::is_nothrow_move_assignable<value_t>::value&&
@@ -23649,26 +20384,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
left.swap(right);
}
- /*!
- @brief exchanges the values
-
- Exchanges the contents of a JSON array with those of @a other. Does not
- invoke any move, copy, or swap operations on individual elements. All
- iterators and references remain valid. The past-the-end iterator is
- invalidated.
-
- @param[in,out] other array to exchange the contents with
-
- @throw type_error.310 when JSON value is not an array; example: `"cannot
- use swap() with string"`
-
- @complexity Constant.
-
- @liveexample{The example below shows how arrays can be swapped with
- `swap()`.,swap__array_t}
-
- @since version 1.0.0
- */
+ /// @brief exchanges the values
+ /// @sa https://json.nlohmann.me/api/basic_json/swap/
void swap(array_t& other) // NOLINT(bugprone-exception-escape)
{
// swap only works for arrays
@@ -23682,26 +20399,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief exchanges the values
-
- Exchanges the contents of a JSON object with those of @a other. Does not
- invoke any move, copy, or swap operations on individual elements. All
- iterators and references remain valid. The past-the-end iterator is
- invalidated.
-
- @param[in,out] other object to exchange the contents with
-
- @throw type_error.310 when JSON value is not an object; example:
- `"cannot use swap() with string"`
-
- @complexity Constant.
-
- @liveexample{The example below shows how objects can be swapped with
- `swap()`.,swap__object_t}
-
- @since version 1.0.0
- */
+ /// @brief exchanges the values
+ /// @sa https://json.nlohmann.me/api/basic_json/swap/
void swap(object_t& other) // NOLINT(bugprone-exception-escape)
{
// swap only works for objects
@@ -23715,26 +20414,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief exchanges the values
-
- Exchanges the contents of a JSON string with those of @a other. Does not
- invoke any move, copy, or swap operations on individual elements. All
- iterators and references remain valid. The past-the-end iterator is
- invalidated.
-
- @param[in,out] other string to exchange the contents with
-
- @throw type_error.310 when JSON value is not a string; example: `"cannot
- use swap() with boolean"`
-
- @complexity Constant.
-
- @liveexample{The example below shows how strings can be swapped with
- `swap()`.,swap__string_t}
-
- @since version 1.0.0
- */
+ /// @brief exchanges the values
+ /// @sa https://json.nlohmann.me/api/basic_json/swap/
void swap(string_t& other) // NOLINT(bugprone-exception-escape)
{
// swap only works for strings
@@ -23748,26 +20429,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /*!
- @brief exchanges the values
-
- Exchanges the contents of a JSON string with those of @a other. Does not
- invoke any move, copy, or swap operations on individual elements. All
- iterators and references remain valid. The past-the-end iterator is
- invalidated.
-
- @param[in,out] other binary to exchange the contents with
-
- @throw type_error.310 when JSON value is not a string; example: `"cannot
- use swap() with boolean"`
-
- @complexity Constant.
-
- @liveexample{The example below shows how strings can be swapped with
- `swap()`.,swap__binary_t}
-
- @since version 3.8.0
- */
+ /// @brief exchanges the values
+ /// @sa https://json.nlohmann.me/api/basic_json/swap/
void swap(binary_t& other) // NOLINT(bugprone-exception-escape)
{
// swap only works for strings
@@ -23781,7 +20444,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
}
}
- /// @copydoc swap(binary_t&)
+ /// @brief exchanges the values
+ /// @sa https://json.nlohmann.me/api/basic_json/swap/
void swap(typename binary_t::container_type& other) // NOLINT(bugprone-exception-escape)
{
// swap only works for strings
@@ -23805,61 +20469,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name lexicographical comparison operators
/// @{
- /*!
- @brief comparison: equal
-
- Compares two JSON values for equality according to the following rules:
- - Two JSON values are equal if (1) they are from the same type and (2)
- their stored values are the same according to their respective
- `operator==`.
- - Integer and floating-point numbers are automatically converted before
- comparison. Note that two NaN values are always treated as unequal.
- - Two JSON null values are equal.
-
- @note Floating-point inside JSON values numbers are compared with
- `json::number_float_t::operator==` which is `double::operator==` by
- default. To compare floating-point while respecting an epsilon, an alternative
- [comparison function](https://github.com/mariokonrad/marnav/blob/master/include/marnav/math/floatingpoint.hpp#L34-#L39)
- could be used, for instance
- @code {.cpp}
- template<typename T, typename = typename std::enable_if<std::is_floating_point<T>::value, T>::type>
- inline bool is_same(T a, T b, T epsilon = std::numeric_limits<T>::epsilon()) noexcept
- {
- return std::abs(a - b) <= epsilon;
- }
- @endcode
- Or you can self-defined operator equal function like this:
- @code {.cpp}
- bool my_equal(const_reference lhs, const_reference rhs) {
- const auto lhs_type lhs.type();
- const auto rhs_type rhs.type();
- if (lhs_type == rhs_type) {
- switch(lhs_type)
- // self_defined case
- case value_t::number_float:
- return std::abs(lhs - rhs) <= std::numeric_limits<float>::epsilon();
- // other cases remain the same with the original
- ...
- }
- ...
- }
- @endcode
-
- @note NaN values never compare equal to themselves or to other NaN values.
-
- @param[in] lhs first JSON value to consider
- @param[in] rhs second JSON value to consider
- @return whether the values @a lhs and @a rhs are equal
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @complexity Linear.
-
- @liveexample{The example demonstrates comparing several JSON
- types.,operator__equal}
-
- @since version 1.0.0
- */
+ /// @brief comparison: equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_eq/
friend bool operator==(const_reference lhs, const_reference rhs) noexcept
{
#ifdef __GNUC__
@@ -23936,10 +20547,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
#endif
}
- /*!
- @brief comparison: equal
- @copydoc operator==(const_reference, const_reference)
- */
+ /// @brief comparison: equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_eq/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator==(const_reference lhs, ScalarType rhs) noexcept
@@ -23947,10 +20556,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return lhs == basic_json(rhs);
}
- /*!
- @brief comparison: equal
- @copydoc operator==(const_reference, const_reference)
- */
+ /// @brief comparison: equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_eq/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator==(ScalarType lhs, const_reference rhs) noexcept
@@ -23958,33 +20565,15 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return basic_json(lhs) == rhs;
}
- /*!
- @brief comparison: not equal
-
- Compares two JSON values for inequality by calculating `not (lhs == rhs)`.
-
- @param[in] lhs first JSON value to consider
- @param[in] rhs second JSON value to consider
- @return whether the values @a lhs and @a rhs are not equal
-
- @complexity Linear.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @liveexample{The example demonstrates comparing several JSON
- types.,operator__notequal}
-
- @since version 1.0.0
- */
+ /// @brief comparison: not equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_ne/
friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
{
return !(lhs == rhs);
}
- /*!
- @brief comparison: not equal
- @copydoc operator!=(const_reference, const_reference)
- */
+ /// @brief comparison: not equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_ne/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator!=(const_reference lhs, ScalarType rhs) noexcept
@@ -23992,10 +20581,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return lhs != basic_json(rhs);
}
- /*!
- @brief comparison: not equal
- @copydoc operator!=(const_reference, const_reference)
- */
+ /// @brief comparison: not equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_ne/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator!=(ScalarType lhs, const_reference rhs) noexcept
@@ -24003,32 +20590,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return basic_json(lhs) != rhs;
}
- /*!
- @brief comparison: less than
-
- Compares whether one JSON value @a lhs is less than another JSON value @a
- rhs according to the following rules:
- - If @a lhs and @a rhs have the same type, the values are compared using
- the default `<` operator.
- - Integer and floating-point numbers are automatically converted before
- comparison
- - In case @a lhs and @a rhs have different types, the values are ignored
- and the order of the types is considered, see
- @ref operator<(const value_t, const value_t).
-
- @param[in] lhs first JSON value to consider
- @param[in] rhs second JSON value to consider
- @return whether @a lhs is less than @a rhs
-
- @complexity Linear.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @liveexample{The example demonstrates comparing several JSON
- types.,operator__less}
-
- @since version 1.0.0
- */
+ /// @brief comparison: less than
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_lt/
friend bool operator<(const_reference lhs, const_reference rhs) noexcept
{
const auto lhs_type = lhs.type();
@@ -24103,10 +20666,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return operator<(lhs_type, rhs_type);
}
- /*!
- @brief comparison: less than
- @copydoc operator<(const_reference, const_reference)
- */
+ /// @brief comparison: less than
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_lt/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator<(const_reference lhs, ScalarType rhs) noexcept
@@ -24114,10 +20675,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return lhs < basic_json(rhs);
}
- /*!
- @brief comparison: less than
- @copydoc operator<(const_reference, const_reference)
- */
+ /// @brief comparison: less than
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_lt/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator<(ScalarType lhs, const_reference rhs) noexcept
@@ -24125,34 +20684,15 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return basic_json(lhs) < rhs;
}
- /*!
- @brief comparison: less than or equal
-
- Compares whether one JSON value @a lhs is less than or equal to another
- JSON value by calculating `not (rhs < lhs)`.
-
- @param[in] lhs first JSON value to consider
- @param[in] rhs second JSON value to consider
- @return whether @a lhs is less than or equal to @a rhs
-
- @complexity Linear.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @liveexample{The example demonstrates comparing several JSON
- types.,operator__greater}
-
- @since version 1.0.0
- */
+ /// @brief comparison: less than or equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_le/
friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
{
return !(rhs < lhs);
}
- /*!
- @brief comparison: less than or equal
- @copydoc operator<=(const_reference, const_reference)
- */
+ /// @brief comparison: less than or equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_le/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator<=(const_reference lhs, ScalarType rhs) noexcept
@@ -24160,10 +20700,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return lhs <= basic_json(rhs);
}
- /*!
- @brief comparison: less than or equal
- @copydoc operator<=(const_reference, const_reference)
- */
+ /// @brief comparison: less than or equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_le/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator<=(ScalarType lhs, const_reference rhs) noexcept
@@ -24171,34 +20709,15 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return basic_json(lhs) <= rhs;
}
- /*!
- @brief comparison: greater than
-
- Compares whether one JSON value @a lhs is greater than another
- JSON value by calculating `not (lhs <= rhs)`.
-
- @param[in] lhs first JSON value to consider
- @param[in] rhs second JSON value to consider
- @return whether @a lhs is greater than to @a rhs
-
- @complexity Linear.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @liveexample{The example demonstrates comparing several JSON
- types.,operator__lessequal}
-
- @since version 1.0.0
- */
+ /// @brief comparison: greater than
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_gt/
friend bool operator>(const_reference lhs, const_reference rhs) noexcept
{
return !(lhs <= rhs);
}
- /*!
- @brief comparison: greater than
- @copydoc operator>(const_reference, const_reference)
- */
+ /// @brief comparison: greater than
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_gt/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator>(const_reference lhs, ScalarType rhs) noexcept
@@ -24206,10 +20725,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return lhs > basic_json(rhs);
}
- /*!
- @brief comparison: greater than
- @copydoc operator>(const_reference, const_reference)
- */
+ /// @brief comparison: greater than
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_gt/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator>(ScalarType lhs, const_reference rhs) noexcept
@@ -24217,34 +20734,15 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return basic_json(lhs) > rhs;
}
- /*!
- @brief comparison: greater than or equal
-
- Compares whether one JSON value @a lhs is greater than or equal to another
- JSON value by calculating `not (lhs < rhs)`.
-
- @param[in] lhs first JSON value to consider
- @param[in] rhs second JSON value to consider
- @return whether @a lhs is greater than or equal to @a rhs
-
- @complexity Linear.
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @liveexample{The example demonstrates comparing several JSON
- types.,operator__greaterequal}
-
- @since version 1.0.0
- */
+ /// @brief comparison: greater than or equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_ge/
friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
{
return !(lhs < rhs);
}
- /*!
- @brief comparison: greater than or equal
- @copydoc operator>=(const_reference, const_reference)
- */
+ /// @brief comparison: greater than or equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_ge/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator>=(const_reference lhs, ScalarType rhs) noexcept
@@ -24252,10 +20750,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return lhs >= basic_json(rhs);
}
- /*!
- @brief comparison: greater than or equal
- @copydoc operator>=(const_reference, const_reference)
- */
+ /// @brief comparison: greater than or equal
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_ge/
template<typename ScalarType, typename std::enable_if<
std::is_scalar<ScalarType>::value, int>::type = 0>
friend bool operator>=(ScalarType lhs, const_reference rhs) noexcept
@@ -24272,37 +20768,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name serialization
/// @{
#ifndef JSON_NO_IO
- /*!
- @brief serialize to stream
-
- Serialize the given JSON value @a j to the output stream @a o. The JSON
- value will be serialized using the @ref dump member function.
-
- - The indentation of the output can be controlled with the member variable
- `width` of the output stream @a o. For instance, using the manipulator
- `std::setw(4)` on @a o sets the indentation level to `4` and the
- serialization result is the same as calling `dump(4)`.
-
- - The indentation character can be controlled with the member variable
- `fill` of the output stream @a o. For instance, the manipulator
- `std::setfill('\\t')` sets indentation to use a tab character rather than
- the default space character.
-
- @param[in,out] o stream to serialize to
- @param[in] j JSON value to serialize
-
- @return the stream @a o
-
- @throw type_error.316 if a string stored inside the JSON value is not
- UTF-8 encoded
-
- @complexity Linear.
-
- @liveexample{The example below shows the serialization with different
- parameters to `width` to adjust the indentation level.,operator_serialize}
-
- @since version 1.0.0; indentation character added in version 3.0.0
- */
+ /// @brief serialize to stream
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_ltlt/
friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
{
// read width member and use it as indentation parameter if nonzero
@@ -24318,14 +20785,12 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return o;
}
- /*!
- @brief serialize to stream
- @deprecated This stream operator is deprecated and will be removed in
- future 4.0.0 of the library. Please use
- @ref operator<<(std::ostream&, const basic_json&)
- instead; that is, replace calls like `j >> o;` with `o << j;`.
- @since version 1.0.0; deprecated since version 3.0.0
- */
+ /// @brief serialize to stream
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_ltlt/
+ /// @deprecated This function is deprecated since 3.0.0 and will be removed in
+ /// version 4.0.0 of the library. Please use
+ /// operator<<(std::ostream&, const basic_json&) instead; that is,
+ /// replace calls like `j >> o;` with `o << j;`.
JSON_HEDLEY_DEPRECATED_FOR(3.0.0, operator<<(std::ostream&, const basic_json&))
friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
{
@@ -24342,57 +20807,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name deserialization
/// @{
- /*!
- @brief deserialize from a compatible input
-
- @tparam InputType A compatible input, for instance
- - an std::istream object
- - a FILE pointer
- - a C-style array of characters
- - a pointer to a null-terminated string of single byte characters
- - an object obj for which begin(obj) and end(obj) produces a valid pair of
- iterators.
-
- @param[in] i input to read from
- @param[in] cb a parser callback function of type @ref parser_callback_t
- which is used to control the deserialization by filtering unwanted values
- (optional)
- @param[in] allow_exceptions whether to throw exceptions in case of a
- parse error (optional, true by default)
- @param[in] ignore_comments whether comments should be ignored and treated
- like whitespace (true) or yield a parse error (true); (optional, false by
- default)
-
- @return deserialized JSON value; in case of a parse error and
- @a allow_exceptions set to `false`, the return value will be
- value_t::discarded.
-
- @throw parse_error.101 if a parse error occurs; example: `""unexpected end
- of input; expected string literal""`
- @throw parse_error.102 if to_unicode fails or surrogate error
- @throw parse_error.103 if to_unicode fails
-
- @complexity Linear in the length of the input. The parser is a predictive
- LL(1) parser. The complexity can be higher if the parser callback function
- @a cb or reading from the input @a i has a super-linear complexity.
-
- @note A UTF-8 byte order mark is silently ignored.
-
- @liveexample{The example below demonstrates the `parse()` function reading
- from an array.,parse__array__parser_callback_t}
-
- @liveexample{The example below demonstrates the `parse()` function with
- and without callback function.,parse__string__parser_callback_t}
-
- @liveexample{The example below demonstrates the `parse()` function with
- and without callback function.,parse__istream__parser_callback_t}
-
- @liveexample{The example below demonstrates the `parse()` function reading
- from a contiguous container.,parse__contiguouscontainer__parser_callback_t}
-
- @since version 2.0.3 (contiguous containers); version 3.9.0 allowed to
- ignore comments.
- */
+ /// @brief deserialize from a compatible input
+ /// @sa https://json.nlohmann.me/api/basic_json/parse/
template<typename InputType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json parse(InputType&& i,
@@ -24405,32 +20821,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief deserialize from a pair of character iterators
-
- The value_type of the iterator must be a integral type with size of 1, 2 or
- 4 bytes, which will be interpreted respectively as UTF-8, UTF-16 and UTF-32.
-
- @param[in] first iterator to start of character range
- @param[in] last iterator to end of character range
- @param[in] cb a parser callback function of type @ref parser_callback_t
- which is used to control the deserialization by filtering unwanted values
- (optional)
- @param[in] allow_exceptions whether to throw exceptions in case of a
- parse error (optional, true by default)
- @param[in] ignore_comments whether comments should be ignored and treated
- like whitespace (true) or yield a parse error (true); (optional, false by
- default)
-
- @return deserialized JSON value; in case of a parse error and
- @a allow_exceptions set to `false`, the return value will be
- value_t::discarded.
-
- @throw parse_error.101 if a parse error occurs; example: `""unexpected end
- of input; expected string literal""`
- @throw parse_error.102 if to_unicode fails or surrogate error
- @throw parse_error.103 if to_unicode fails
- */
+ /// @brief deserialize from a pair of character iterators
+ /// @sa https://json.nlohmann.me/api/basic_json/parse/
template<typename IteratorType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json parse(IteratorType first,
@@ -24456,36 +20848,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief check if the input is valid JSON
-
- Unlike the @ref parse(InputType&&, const parser_callback_t,const bool)
- function, this function neither throws an exception in case of invalid JSON
- input (i.e., a parse error) nor creates diagnostic information.
-
- @tparam InputType A compatible input, for instance
- - an std::istream object
- - a FILE pointer
- - a C-style array of characters
- - a pointer to a null-terminated string of single byte characters
- - an object obj for which begin(obj) and end(obj) produces a valid pair of
- iterators.
-
- @param[in] i input to read from
- @param[in] ignore_comments whether comments should be ignored and treated
- like whitespace (true) or yield a parse error (true); (optional, false by
- default)
-
- @return Whether the input read from @a i is valid JSON.
-
- @complexity Linear in the length of the input. The parser is a predictive
- LL(1) parser.
-
- @note A UTF-8 byte order mark is silently ignored.
-
- @liveexample{The example below demonstrates the `accept()` function reading
- from a string.,accept__string}
- */
+ /// @brief check if the input is valid JSON
+ /// @sa https://json.nlohmann.me/api/basic_json/accept/
template<typename InputType>
static bool accept(InputType&& i,
const bool ignore_comments = false)
@@ -24493,6 +20857,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return parser(detail::input_adapter(std::forward<InputType>(i)), nullptr, false, ignore_comments).accept(true);
}
+ /// @brief check if the input is valid JSON
+ /// @sa https://json.nlohmann.me/api/basic_json/accept/
template<typename IteratorType>
static bool accept(IteratorType first, IteratorType last,
const bool ignore_comments = false)
@@ -24508,46 +20874,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return parser(i.get(), nullptr, false, ignore_comments).accept(true);
}
- /*!
- @brief generate SAX events
-
- The SAX event lister must follow the interface of @ref json_sax.
-
- This function reads from a compatible input. Examples are:
- - an std::istream object
- - a FILE pointer
- - a C-style array of characters
- - a pointer to a null-terminated string of single byte characters
- - an object obj for which begin(obj) and end(obj) produces a valid pair of
- iterators.
-
- @param[in] i input to read from
- @param[in,out] sax SAX event listener
- @param[in] format the format to parse (JSON, CBOR, MessagePack, or UBJSON)
- @param[in] strict whether the input has to be consumed completely
- @param[in] ignore_comments whether comments should be ignored and treated
- like whitespace (true) or yield a parse error (true); (optional, false by
- default); only applies to the JSON file format.
-
- @return return value of the last processed SAX event
-
- @throw parse_error.101 if a parse error occurs; example: `""unexpected end
- of input; expected string literal""`
- @throw parse_error.102 if to_unicode fails or surrogate error
- @throw parse_error.103 if to_unicode fails
-
- @complexity Linear in the length of the input. The parser is a predictive
- LL(1) parser. The complexity can be higher if the SAX consumer @a sax has
- a super-linear complexity.
-
- @note A UTF-8 byte order mark is silently ignored.
-
- @liveexample{The example below demonstrates the `sax_parse()` function
- reading from string and processing the events with a user-defined SAX
- event consumer.,sax_parse}
-
- @since version 3.2.0
- */
+ /// @brief generate SAX events
+ /// @sa https://json.nlohmann.me/api/basic_json/sax_parse/
template <typename InputType, typename SAX>
JSON_HEDLEY_NON_NULL(2)
static bool sax_parse(InputType&& i, SAX* sax,
@@ -24561,6 +20889,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
: detail::binary_reader<basic_json, decltype(ia), SAX>(std::move(ia)).sax_parse(format, sax, strict);
}
+ /// @brief generate SAX events
+ /// @sa https://json.nlohmann.me/api/basic_json/sax_parse/
template<class IteratorType, class SAX>
JSON_HEDLEY_NON_NULL(3)
static bool sax_parse(IteratorType first, IteratorType last, SAX* sax,
@@ -24574,6 +20904,11 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
: detail::binary_reader<basic_json, decltype(ia), SAX>(std::move(ia)).sax_parse(format, sax, strict);
}
+ /// @brief generate SAX events
+ /// @sa https://json.nlohmann.me/api/basic_json/sax_parse/
+ /// @deprecated This function is deprecated since 3.8.0 and will be removed in
+ /// version 4.0.0 of the library. Please use
+ /// sax_parse(ptr, ptr + len) instead.
template <typename SAX>
JSON_HEDLEY_DEPRECATED_FOR(3.8.0, sax_parse(ptr, ptr + len, ...))
JSON_HEDLEY_NON_NULL(2)
@@ -24590,45 +20925,20 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
: detail::binary_reader<basic_json, decltype(ia), SAX>(std::move(ia)).sax_parse(format, sax, strict);
}
#ifndef JSON_NO_IO
- /*!
- @brief deserialize from stream
- @deprecated This stream operator is deprecated and will be removed in
- version 4.0.0 of the library. Please use
- @ref operator>>(std::istream&, basic_json&)
- instead; that is, replace calls like `j << i;` with `i >> j;`.
- @since version 1.0.0; deprecated since version 3.0.0
- */
+ /// @brief deserialize from stream
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_gtgt/
+ /// @deprecated This stream operator is deprecated since 3.0.0 and will be removed in
+ /// version 4.0.0 of the library. Please use
+ /// operator>>(std::istream&, basic_json&) instead; that is,
+ /// replace calls like `j << i;` with `i >> j;`.
JSON_HEDLEY_DEPRECATED_FOR(3.0.0, operator>>(std::istream&, basic_json&))
friend std::istream& operator<<(basic_json& j, std::istream& i)
{
return operator>>(i, j);
}
- /*!
- @brief deserialize from stream
-
- Deserializes an input stream to a JSON value.
-
- @param[in,out] i input stream to read a serialized JSON value from
- @param[in,out] j JSON value to write the deserialized input to
-
- @throw parse_error.101 in case of an unexpected token
- @throw parse_error.102 if to_unicode fails or surrogate error
- @throw parse_error.103 if to_unicode fails
-
- @complexity Linear in the length of the input. The parser is a predictive
- LL(1) parser.
-
- @note A UTF-8 byte order mark is silently ignored.
-
- @liveexample{The example below shows how a JSON value is constructed by
- reading a serialization from a stream.,operator_deserialize}
-
- @sa parse(std::istream&, const parser_callback_t) for a variant with a
- parser callback function to filter values while parsing
-
- @since version 1.0.0
- */
+ /// @brief deserialize from stream
+ /// @sa https://json.nlohmann.me/api/basic_json/operator_gtgt/
friend std::istream& operator>>(std::istream& i, basic_json& j)
{
parser(detail::input_adapter(i)).parse(false, j);
@@ -24641,63 +20951,32 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
// convenience functions //
///////////////////////////
- /*!
- @brief return the type as string
-
- Returns the type name as string to be used in error messages - usually to
- indicate that a function was called on a wrong JSON type.
-
- @return a string representation of a the @a m_type member:
- Value type | return value
- ----------- | -------------
- null | `"null"`
- boolean | `"boolean"`
- string | `"string"`
- number | `"number"` (for all number types)
- object | `"object"`
- array | `"array"`
- binary | `"binary"`
- discarded | `"discarded"`
-
- @exceptionsafety No-throw guarantee: this function never throws exceptions.
-
- @complexity Constant.
-
- @liveexample{The following code exemplifies `type_name()` for all JSON
- types.,type_name}
-
- @sa see @ref type() -- return the type of the JSON value
- @sa see @ref operator value_t() -- return the type of the JSON value (implicit)
-
- @since version 1.0.0, public since 2.1.0, `const char*` and `noexcept`
- since 3.0.0
- */
+ /// @brief return the type as string
+ /// @sa https://json.nlohmann.me/api/basic_json/type_name/
JSON_HEDLEY_RETURNS_NON_NULL
const char* type_name() const noexcept
{
+ switch (m_type)
{
- switch (m_type)
- {
- case value_t::null:
- return "null";
- case value_t::object:
- return "object";
- case value_t::array:
- return "array";
- case value_t::string:
- return "string";
- case value_t::boolean:
- return "boolean";
- case value_t::binary:
- return "binary";
- case value_t::discarded:
- return "discarded";
- case value_t::number_integer:
- case value_t::number_unsigned:
- case value_t::number_float:
- default:
- return "number";
- }
+ case value_t::null:
+ return "null";
+ case value_t::object:
+ return "object";
+ case value_t::array:
+ return "array";
+ case value_t::string:
+ return "string";
+ case value_t::boolean:
+ return "boolean";
+ case value_t::binary:
+ return "binary";
+ case value_t::discarded:
+ return "discarded";
+ case value_t::number_integer:
+ case value_t::number_unsigned:
+ case value_t::number_float:
+ default:
+ return "number";
}
}
@@ -24726,104 +21005,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @{
public:
- /*!
- @brief create a CBOR serialization of a given JSON value
-
- Serializes a given JSON value @a j to a byte vector using the CBOR (Concise
- Binary Object Representation) serialization format. CBOR is a binary
- serialization format which aims to be more compact than JSON itself, yet
- more efficient to parse.
-
- The library uses the following mapping from JSON values types to
- CBOR types according to the CBOR specification (RFC 7049):
-
- JSON value type | value/range | CBOR type | first byte
- --------------- | ------------------------------------------ | ---------------------------------- | ---------------
- null | `null` | Null | 0xF6
- boolean | `true` | True | 0xF5
- boolean | `false` | False | 0xF4
- number_integer | -9223372036854775808..-2147483649 | Negative integer (8 bytes follow) | 0x3B
- number_integer | -2147483648..-32769 | Negative integer (4 bytes follow) | 0x3A
- number_integer | -32768..-129 | Negative integer (2 bytes follow) | 0x39
- number_integer | -128..-25 | Negative integer (1 byte follow) | 0x38
- number_integer | -24..-1 | Negative integer | 0x20..0x37
- number_integer | 0..23 | Integer | 0x00..0x17
- number_integer | 24..255 | Unsigned integer (1 byte follow) | 0x18
- number_integer | 256..65535 | Unsigned integer (2 bytes follow) | 0x19
- number_integer | 65536..4294967295 | Unsigned integer (4 bytes follow) | 0x1A
- number_integer | 4294967296..18446744073709551615 | Unsigned integer (8 bytes follow) | 0x1B
- number_unsigned | 0..23 | Integer | 0x00..0x17
- number_unsigned | 24..255 | Unsigned integer (1 byte follow) | 0x18
- number_unsigned | 256..65535 | Unsigned integer (2 bytes follow) | 0x19
- number_unsigned | 65536..4294967295 | Unsigned integer (4 bytes follow) | 0x1A
- number_unsigned | 4294967296..18446744073709551615 | Unsigned integer (8 bytes follow) | 0x1B
- number_float | *any value representable by a float* | Single-Precision Float | 0xFA
- number_float | *any value NOT representable by a float* | Double-Precision Float | 0xFB
- string | *length*: 0..23 | UTF-8 string | 0x60..0x77
- string | *length*: 23..255 | UTF-8 string (1 byte follow) | 0x78
- string | *length*: 256..65535 | UTF-8 string (2 bytes follow) | 0x79
- string | *length*: 65536..4294967295 | UTF-8 string (4 bytes follow) | 0x7A
- string | *length*: 4294967296..18446744073709551615 | UTF-8 string (8 bytes follow) | 0x7B
- array | *size*: 0..23 | array | 0x80..0x97
- array | *size*: 23..255 | array (1 byte follow) | 0x98
- array | *size*: 256..65535 | array (2 bytes follow) | 0x99
- array | *size*: 65536..4294967295 | array (4 bytes follow) | 0x9A
- array | *size*: 4294967296..18446744073709551615 | array (8 bytes follow) | 0x9B
- object | *size*: 0..23 | map | 0xA0..0xB7
- object | *size*: 23..255 | map (1 byte follow) | 0xB8
- object | *size*: 256..65535 | map (2 bytes follow) | 0xB9
- object | *size*: 65536..4294967295 | map (4 bytes follow) | 0xBA
- object | *size*: 4294967296..18446744073709551615 | map (8 bytes follow) | 0xBB
- binary | *size*: 0..23 | byte string | 0x40..0x57
- binary | *size*: 23..255 | byte string (1 byte follow) | 0x58
- binary | *size*: 256..65535 | byte string (2 bytes follow) | 0x59
- binary | *size*: 65536..4294967295 | byte string (4 bytes follow) | 0x5A
- binary | *size*: 4294967296..18446744073709551615 | byte string (8 bytes follow) | 0x5B
-
- Binary values with subtype are mapped to tagged values (0xD8..0xDB)
- depending on the subtype, followed by a byte string, see "binary" cells
- in the table above.
-
- @note The mapping is **complete** in the sense that any JSON value type
- can be converted to a CBOR value.
-
- @note If NaN or Infinity are stored inside a JSON number, they are
- serialized properly. This behavior differs from the @ref dump()
- function which serializes NaN or Infinity to `null`.
-
- @note The following CBOR types are not used in the conversion:
- - UTF-8 strings terminated by "break" (0x7F)
- - arrays terminated by "break" (0x9F)
- - maps terminated by "break" (0xBF)
- - byte strings terminated by "break" (0x5F)
- - date/time (0xC0..0xC1)
- - bignum (0xC2..0xC3)
- - decimal fraction (0xC4)
- - bigfloat (0xC5)
- - expected conversions (0xD5..0xD7)
- - simple values (0xE0..0xF3, 0xF8)
- - undefined (0xF7)
- - half-precision floats (0xF9)
- - break (0xFF)
-
- @param[in] j JSON value to serialize
- @return CBOR serialization as byte vector
-
- @complexity Linear in the size of the JSON value @a j.
-
- @liveexample{The example shows the serialization of a JSON value to a byte
- vector in CBOR format.,to_cbor}
-
- @sa http://cbor.io
- @sa see @ref from_cbor(InputType&&, const bool, const bool, const cbor_tag_handler_t) for the
- analogous deserialization
- @sa see @ref to_msgpack(const basic_json&) for the related MessagePack format
- @sa see @ref to_ubjson(const basic_json&, const bool, const bool) for the
- related UBJSON format
-
- @since version 2.0.9; compact representation of floating-point numbers
- since version 3.8.0
- */
+ /// @brief create a CBOR serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_cbor/
static std::vector<std::uint8_t> to_cbor(const basic_json& j)
{
std::vector<std::uint8_t> result;
@@ -24831,94 +21014,22 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
+ /// @brief create a CBOR serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_cbor/
static void to_cbor(const basic_json& j, detail::output_adapter<std::uint8_t> o)
{
binary_writer<std::uint8_t>(o).write_cbor(j);
}
+ /// @brief create a CBOR serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_cbor/
static void to_cbor(const basic_json& j, detail::output_adapter<char> o)
{
binary_writer<char>(o).write_cbor(j);
}
- /*!
- @brief create a MessagePack serialization of a given JSON value
-
- Serializes a given JSON value @a j to a byte vector using the MessagePack
- serialization format. MessagePack is a binary serialization format which
- aims to be more compact than JSON itself, yet more efficient to parse.
-
- The library uses the following mapping from JSON values types to
- MessagePack types according to the MessagePack specification:
-
- JSON value type | value/range | MessagePack type | first byte
- --------------- | --------------------------------- | ---------------- | ----------
- null | `null` | nil | 0xC0
- boolean | `true` | true | 0xC3
- boolean | `false` | false | 0xC2
- number_integer | -9223372036854775808..-2147483649 | int64 | 0xD3
- number_integer | -2147483648..-32769 | int32 | 0xD2
- number_integer | -32768..-129 | int16 | 0xD1
- number_integer | -128..-33 | int8 | 0xD0
- number_integer | -32..-1 | negative fixint | 0xE0..0xFF
- number_integer | 0..127 | positive fixint | 0x00..0x7F
- number_integer | 128..255 | uint 8 | 0xCC
- number_integer | 256..65535 | uint 16 | 0xCD
- number_integer | 65536..4294967295 | uint 32 | 0xCE
- number_integer | 4294967296..18446744073709551615 | uint 64 | 0xCF
- number_unsigned | 0..127 | positive fixint | 0x00..0x7F
- number_unsigned | 128..255 | uint 8 | 0xCC
- number_unsigned | 256..65535 | uint 16 | 0xCD
- number_unsigned | 65536..4294967295 | uint 32 | 0xCE
- number_unsigned | 4294967296..18446744073709551615 | uint 64 | 0xCF
- number_float | *any value representable by a float* | float 32 | 0xCA
- number_float | *any value NOT representable by a float* | float 64 | 0xCB
- string | *length*: 0..31 | fixstr | 0xA0..0xBF
- string | *length*: 32..255 | str 8 | 0xD9
- string | *length*: 256..65535 | str 16 | 0xDA
- string | *length*: 65536..4294967295 | str 32 | 0xDB
- array | *size*: 0..15 | fixarray | 0x90..0x9F
- array | *size*: 16..65535 | array 16 | 0xDC
- array | *size*: 65536..4294967295 | array 32 | 0xDD
- object | *size*: 0..15 | fix map | 0x80..0x8F
- object | *size*: 16..65535 | map 16 | 0xDE
- object | *size*: 65536..4294967295 | map 32 | 0xDF
- binary | *size*: 0..255 | bin 8 | 0xC4
- binary | *size*: 256..65535 | bin 16 | 0xC5
- binary | *size*: 65536..4294967295 | bin 32 | 0xC6
-
- @note The mapping is **complete** in the sense that any JSON value type
- can be converted to a MessagePack value.
-
- @note The following values can **not** be converted to a MessagePack value:
- - strings with more than 4294967295 bytes
- - byte strings with more than 4294967295 bytes
- - arrays with more than 4294967295 elements
- - objects with more than 4294967295 elements
-
- @note Any MessagePack output created @ref to_msgpack can be successfully
- parsed by @ref from_msgpack.
-
- @note If NaN or Infinity are stored inside a JSON number, they are
- serialized properly. This behavior differs from the @ref dump()
- function which serializes NaN or Infinity to `null`.
-
- @param[in] j JSON value to serialize
- @return MessagePack serialization as byte vector
-
- @complexity Linear in the size of the JSON value @a j.
-
- @liveexample{The example shows the serialization of a JSON value to a byte
- vector in MessagePack format.,to_msgpack}
-
- @sa http://msgpack.org
- @sa see @ref from_msgpack for the analogous deserialization
- @sa see @ref to_cbor(const basic_json& for the related CBOR format
- @sa see @ref to_ubjson(const basic_json&, const bool, const bool) for the
- related UBJSON format
-
- @since version 2.0.9
- */
+ /// @brief create a MessagePack serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_msgpack/
static std::vector<std::uint8_t> to_msgpack(const basic_json& j)
{
std::vector<std::uint8_t> result;
@@ -24926,102 +21037,22 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
+ /// @brief create a MessagePack serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_msgpack/
static void to_msgpack(const basic_json& j, detail::output_adapter<std::uint8_t> o)
{
binary_writer<std::uint8_t>(o).write_msgpack(j);
}
+ /// @brief create a MessagePack serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_msgpack/
static void to_msgpack(const basic_json& j, detail::output_adapter<char> o)
{
binary_writer<char>(o).write_msgpack(j);
}
- /*!
- @brief create a UBJSON serialization of a given JSON value
-
- Serializes a given JSON value @a j to a byte vector using the UBJSON
- (Universal Binary JSON) serialization format. UBJSON aims to be more compact
- than JSON itself, yet more efficient to parse.
-
- The library uses the following mapping from JSON values types to
- UBJSON types according to the UBJSON specification:
-
- JSON value type | value/range | UBJSON type | marker
- --------------- | --------------------------------- | ----------- | ------
- null | `null` | null | `Z`
- boolean | `true` | true | `T`
- boolean | `false` | false | `F`
- number_integer | -9223372036854775808..-2147483649 | int64 | `L`
- number_integer | -2147483648..-32769 | int32 | `l`
- number_integer | -32768..-129 | int16 | `I`
- number_integer | -128..127 | int8 | `i`
- number_integer | 128..255 | uint8 | `U`
- number_integer | 256..32767 | int16 | `I`
- number_integer | 32768..2147483647 | int32 | `l`
- number_integer | 2147483648..9223372036854775807 | int64 | `L`
- number_unsigned | 0..127 | int8 | `i`
- number_unsigned | 128..255 | uint8 | `U`
- number_unsigned | 256..32767 | int16 | `I`
- number_unsigned | 32768..2147483647 | int32 | `l`
- number_unsigned | 2147483648..9223372036854775807 | int64 | `L`
- number_unsigned | 2147483649..18446744073709551615 | high-precision | `H`
- number_float | *any value* | float64 | `D`
- string | *with shortest length indicator* | string | `S`
- array | *see notes on optimized format* | array | `[`
- object | *see notes on optimized format* | map | `{`
-
- @note The mapping is **complete** in the sense that any JSON value type
- can be converted to a UBJSON value.
-
- @note The following values can **not** be converted to a UBJSON value:
- - strings with more than 9223372036854775807 bytes (theoretical)
-
- @note The following markers are not used in the conversion:
- - `Z`: no-op values are not created.
- - `C`: single-byte strings are serialized with `S` markers.
-
- @note Any UBJSON output created @ref to_ubjson can be successfully parsed
- by @ref from_ubjson.
-
- @note If NaN or Infinity are stored inside a JSON number, they are
- serialized properly. This behavior differs from the @ref dump()
- function which serializes NaN or Infinity to `null`.
-
- @note The optimized formats for containers are supported: Parameter
- @a use_size adds size information to the beginning of a container and
- removes the closing marker. Parameter @a use_type further checks
- whether all elements of a container have the same type and adds the
- type marker to the beginning of the container. The @a use_type
- parameter must only be used together with @a use_size = true. Note
- that @a use_size = true alone may result in larger representations -
- the benefit of this parameter is that the receiving side is
- immediately informed on the number of elements of the container.
-
- @note If the JSON data contains the binary type, the value stored is a list
- of integers, as suggested by the UBJSON documentation. In particular,
- this means that serialization and the deserialization of a JSON
- containing binary values into UBJSON and back will result in a
- different JSON object.
-
- @param[in] j JSON value to serialize
- @param[in] use_size whether to add size annotations to container types
- @param[in] use_type whether to add type annotations to container types
- (must be combined with @a use_size = true)
- @return UBJSON serialization as byte vector
-
- @complexity Linear in the size of the JSON value @a j.
-
- @liveexample{The example shows the serialization of a JSON value to a byte
- vector in UBJSON format.,to_ubjson}
-
- @sa http://ubjson.org
- @sa see @ref from_ubjson(InputType&&, const bool, const bool) for the
- analogous deserialization
- @sa see @ref to_cbor(const basic_json& for the related CBOR format
- @sa see @ref to_msgpack(const basic_json&) for the related MessagePack format
-
- @since version 3.1.0
- */
+ /// @brief create a UBJSON serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_ubjson/
static std::vector<std::uint8_t> to_ubjson(const basic_json& j,
const bool use_size = false,
const bool use_type = false)
@@ -25031,75 +21062,24 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
+ /// @brief create a UBJSON serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_ubjson/
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)
{
binary_writer<std::uint8_t>(o).write_ubjson(j, use_size, use_type);
}
+ /// @brief create a UBJSON serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_ubjson/
static void to_ubjson(const basic_json& j, detail::output_adapter<char> o,
const bool use_size = false, const bool use_type = false)
{
binary_writer<char>(o).write_ubjson(j, use_size, use_type);
}
-
- /*!
- @brief Serializes the given JSON object `j` to BSON and returns a vector
- containing the corresponding BSON-representation.
-
- BSON (Binary JSON) is a binary format in which zero or more ordered key/value pairs are
- stored as a single entity (a so-called document).
-
- The library uses the following mapping from JSON values types to BSON types:
-
- JSON value type | value/range | BSON type | marker
- --------------- | --------------------------------- | ----------- | ------
- null | `null` | null | 0x0A
- boolean | `true`, `false` | boolean | 0x08
- number_integer | -9223372036854775808..-2147483649 | int64 | 0x12
- number_integer | -2147483648..2147483647 | int32 | 0x10
- number_integer | 2147483648..9223372036854775807 | int64 | 0x12
- number_unsigned | 0..2147483647 | int32 | 0x10
- number_unsigned | 2147483648..9223372036854775807 | int64 | 0x12
- number_unsigned | 9223372036854775808..18446744073709551615| -- | --
- number_float | *any value* | double | 0x01
- string | *any value* | string | 0x02
- array | *any value* | document | 0x04
- object | *any value* | document | 0x03
- binary | *any value* | binary | 0x05
-
- @warning The mapping is **incomplete**, since only JSON-objects (and things
- contained therein) can be serialized to BSON.
- Also, integers larger than 9223372036854775807 cannot be serialized to BSON,
- and the keys may not contain U+0000, since they are serialized a
- zero-terminated c-strings.
-
- @throw out_of_range.407 if `j.is_number_unsigned() && j.get<std::uint64_t>() > 9223372036854775807`
- @throw out_of_range.409 if a key in `j` contains a NULL (U+0000)
- @throw type_error.317 if `!j.is_object()`
-
- @pre The input `j` is required to be an object: `j.is_object() == true`.
-
- @note Any BSON output created via @ref to_bson can be successfully parsed
- by @ref from_bson.
-
- @param[in] j JSON value to serialize
- @return BSON serialization as byte vector
-
- @complexity Linear in the size of the JSON value @a j.
-
- @liveexample{The example shows the serialization of a JSON value to a byte
- vector in BSON format.,to_bson}
-
- @sa http://bsonspec.org/spec.html
- @sa see @ref from_bson(detail::input_adapter&&, const bool strict) for the
- analogous deserialization
- @sa see @ref to_ubjson(const basic_json&, const bool, const bool) for the
- related UBJSON format
- @sa see @ref to_cbor(const basic_json&) for the related CBOR format
- @sa see @ref to_msgpack(const basic_json&) for the related MessagePack format
- */
+ /// @brief create a BSON serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_bson/
static std::vector<std::uint8_t> to_bson(const basic_json& j)
{
std::vector<std::uint8_t> result;
@@ -25107,130 +21087,22 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief Serializes the given JSON object `j` to BSON and forwards the
- corresponding BSON-representation to the given output_adapter `o`.
- @param j The JSON object to convert to BSON.
- @param o The output adapter that receives the binary BSON representation.
- @pre The input `j` shall be an object: `j.is_object() == true`
- @sa see @ref to_bson(const basic_json&)
- */
+ /// @brief create a BSON serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_bson/
static void to_bson(const basic_json& j, detail::output_adapter<std::uint8_t> o)
{
binary_writer<std::uint8_t>(o).write_bson(j);
}
- /*!
- @copydoc to_bson(const basic_json&, detail::output_adapter<std::uint8_t>)
- */
+ /// @brief create a BSON serialization of a given JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/to_bson/
static void to_bson(const basic_json& j, detail::output_adapter<char> o)
{
binary_writer<char>(o).write_bson(j);
}
-
- /*!
- @brief create a JSON value from an input in CBOR format
-
- Deserializes a given input @a i to a JSON value using the CBOR (Concise
- Binary Object Representation) serialization format.
-
- The library maps CBOR types to JSON value types as follows:
-
- CBOR type | JSON value type | first byte
- ---------------------- | --------------- | ----------
- Integer | number_unsigned | 0x00..0x17
- Unsigned integer | number_unsigned | 0x18
- Unsigned integer | number_unsigned | 0x19
- Unsigned integer | number_unsigned | 0x1A
- Unsigned integer | number_unsigned | 0x1B
- Negative integer | number_integer | 0x20..0x37
- Negative integer | number_integer | 0x38
- Negative integer | number_integer | 0x39
- Negative integer | number_integer | 0x3A
- Negative integer | number_integer | 0x3B
- Byte string | binary | 0x40..0x57
- Byte string | binary | 0x58
- Byte string | binary | 0x59
- Byte string | binary | 0x5A
- Byte string | binary | 0x5B
- UTF-8 string | string | 0x60..0x77
- UTF-8 string | string | 0x78
- UTF-8 string | string | 0x79
- UTF-8 string | string | 0x7A
- UTF-8 string | string | 0x7B
- UTF-8 string | string | 0x7F
- array | array | 0x80..0x97
- array | array | 0x98
- array | array | 0x99
- array | array | 0x9A
- array | array | 0x9B
- array | array | 0x9F
- map | object | 0xA0..0xB7
- map | object | 0xB8
- map | object | 0xB9
- map | object | 0xBA
- map | object | 0xBB
- map | object | 0xBF
- False | `false` | 0xF4
- True | `true` | 0xF5
- Null | `null` | 0xF6
- Half-Precision Float | number_float | 0xF9
- Single-Precision Float | number_float | 0xFA
- Double-Precision Float | number_float | 0xFB
-
- @warning The mapping is **incomplete** in the sense that not all CBOR
- types can be converted to a JSON value. The following CBOR types
- are not supported and will yield parse errors (parse_error.112):
- - date/time (0xC0..0xC1)
- - bignum (0xC2..0xC3)
- - decimal fraction (0xC4)
- - bigfloat (0xC5)
- - expected conversions (0xD5..0xD7)
- - simple values (0xE0..0xF3, 0xF8)
- - undefined (0xF7)
-
- @warning CBOR allows map keys of any type, whereas JSON only allows
- strings as keys in object values. Therefore, CBOR maps with keys
- other than UTF-8 strings are rejected (parse_error.113).
-
- @note Any CBOR output created @ref to_cbor can be successfully parsed by
- @ref from_cbor.
-
- @param[in] i an input in CBOR format convertible to an input adapter
- @param[in] strict whether to expect the input to be consumed until EOF
- (true by default)
- @param[in] allow_exceptions whether to throw exceptions in case of a
- parse error (optional, true by default)
- @param[in] tag_handler how to treat CBOR tags (optional, error by default)
-
- @return deserialized JSON value; in case of a parse error and
- @a allow_exceptions set to `false`, the return value will be
- value_t::discarded.
-
- @throw parse_error.110 if the given input ends prematurely or the end of
- file was not reached when @a strict was set to true
- @throw parse_error.112 if unsupported features from CBOR were
- used in the given input @a v or if the input is not valid CBOR
- @throw parse_error.113 if a string was expected as map key, but not found
-
- @complexity Linear in the size of the input @a i.
-
- @liveexample{The example shows the deserialization of a byte vector in CBOR
- format to a JSON value.,from_cbor}
-
- @sa http://cbor.io
- @sa see @ref to_cbor(const basic_json&) for the analogous serialization
- @sa see @ref from_msgpack(InputType&&, const bool, const bool) for the
- related MessagePack format
- @sa see @ref from_ubjson(InputType&&, const bool, const bool) for the
- related UBJSON format
-
- @since version 2.0.9; parameter @a start_index since 2.1.1; changed to
- consume input adapters, removed start_index parameter, and added
- @a strict parameter since 3.0.0; added @a allow_exceptions parameter
- since 3.2.0; added @a tag_handler parameter since 3.9.0.
- */
+ /// @brief create a JSON value from an input in CBOR format
+ /// @sa https://json.nlohmann.me/api/basic_json/from_cbor/
template<typename InputType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json from_cbor(InputType&& i,
@@ -25245,9 +21117,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res ? result : basic_json(value_t::discarded);
}
- /*!
- @copydoc from_cbor(InputType&&, const bool, const bool, const cbor_tag_handler_t)
- */
+ /// @brief create a JSON value from an input in CBOR format
+ /// @sa https://json.nlohmann.me/api/basic_json/from_cbor/
template<typename IteratorType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json from_cbor(IteratorType first, IteratorType last,
@@ -25289,92 +21160,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res ? result : basic_json(value_t::discarded);
}
- /*!
- @brief create a JSON value from an input in MessagePack format
-
- Deserializes a given input @a i to a JSON value using the MessagePack
- serialization format.
-
- The library maps MessagePack types to JSON value types as follows:
-
- MessagePack type | JSON value type | first byte
- ---------------- | --------------- | ----------
- positive fixint | number_unsigned | 0x00..0x7F
- fixmap | object | 0x80..0x8F
- fixarray | array | 0x90..0x9F
- fixstr | string | 0xA0..0xBF
- nil | `null` | 0xC0
- false | `false` | 0xC2
- true | `true` | 0xC3
- float 32 | number_float | 0xCA
- float 64 | number_float | 0xCB
- uint 8 | number_unsigned | 0xCC
- uint 16 | number_unsigned | 0xCD
- uint 32 | number_unsigned | 0xCE
- uint 64 | number_unsigned | 0xCF
- int 8 | number_integer | 0xD0
- int 16 | number_integer | 0xD1
- int 32 | number_integer | 0xD2
- int 64 | number_integer | 0xD3
- str 8 | string | 0xD9
- str 16 | string | 0xDA
- str 32 | string | 0xDB
- array 16 | array | 0xDC
- array 32 | array | 0xDD
- map 16 | object | 0xDE
- map 32 | object | 0xDF
- bin 8 | binary | 0xC4
- bin 16 | binary | 0xC5
- bin 32 | binary | 0xC6
- ext 8 | binary | 0xC7
- ext 16 | binary | 0xC8
- ext 32 | binary | 0xC9
- fixext 1 | binary | 0xD4
- fixext 2 | binary | 0xD5
- fixext 4 | binary | 0xD6
- fixext 8 | binary | 0xD7
- fixext 16 | binary | 0xD8
- negative fixint | number_integer | 0xE0-0xFF
-
- @note Any MessagePack output created @ref to_msgpack can be successfully
- parsed by @ref from_msgpack.
-
- @param[in] i an input in MessagePack format convertible to an input
- adapter
- @param[in] strict whether to expect the input to be consumed until EOF
- (true by default)
- @param[in] allow_exceptions whether to throw exceptions in case of a
- parse error (optional, true by default)
-
- @return deserialized JSON value; in case of a parse error and
- @a allow_exceptions set to `false`, the return value will be
- value_t::discarded.
-
- @throw parse_error.110 if the given input ends prematurely or the end of
- file was not reached when @a strict was set to true
- @throw parse_error.112 if unsupported features from MessagePack were
- used in the given input @a i or if the input is not valid MessagePack
- @throw parse_error.113 if a string was expected as map key, but not found
-
- @complexity Linear in the size of the input @a i.
-
- @liveexample{The example shows the deserialization of a byte vector in
- MessagePack format to a JSON value.,from_msgpack}
-
- @sa http://msgpack.org
- @sa see @ref to_msgpack(const basic_json&) for the analogous serialization
- @sa see @ref from_cbor(InputType&&, const bool, const bool, const cbor_tag_handler_t) for the
- related CBOR format
- @sa see @ref from_ubjson(InputType&&, const bool, const bool) for
- the related UBJSON format
- @sa see @ref from_bson(InputType&&, const bool, const bool) for
- the related BSON format
-
- @since version 2.0.9; parameter @a start_index since 2.1.1; changed to
- consume input adapters, removed start_index parameter, and added
- @a strict parameter since 3.0.0; added @a allow_exceptions parameter
- since 3.2.0
- */
+ /// @brief create a JSON value from an input in MessagePack format
+ /// @sa https://json.nlohmann.me/api/basic_json/from_msgpack/
template<typename InputType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json from_msgpack(InputType&& i,
@@ -25388,9 +21175,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res ? result : basic_json(value_t::discarded);
}
- /*!
- @copydoc from_msgpack(InputType&&, const bool, const bool)
- */
+ /// @brief create a JSON value from an input in MessagePack format
+ /// @sa https://json.nlohmann.me/api/basic_json/from_msgpack/
template<typename IteratorType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json from_msgpack(IteratorType first, IteratorType last,
@@ -25404,7 +21190,6 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res ? result : basic_json(value_t::discarded);
}
-
template<typename T>
JSON_HEDLEY_WARN_UNUSED_RESULT
JSON_HEDLEY_DEPRECATED_FOR(3.8.0, from_msgpack(ptr, ptr + len))
@@ -25429,69 +21214,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res ? result : basic_json(value_t::discarded);
}
-
- /*!
- @brief create a JSON value from an input in UBJSON format
-
- Deserializes a given input @a i to a JSON value using the UBJSON (Universal
- Binary JSON) serialization format.
-
- The library maps UBJSON types to JSON value types as follows:
-
- UBJSON type | JSON value type | marker
- ----------- | --------------------------------------- | ------
- no-op | *no value, next value is read* | `N`
- null | `null` | `Z`
- false | `false` | `F`
- true | `true` | `T`
- float32 | number_float | `d`
- float64 | number_float | `D`
- uint8 | number_unsigned | `U`
- int8 | number_integer | `i`
- int16 | number_integer | `I`
- int32 | number_integer | `l`
- int64 | number_integer | `L`
- high-precision number | number_integer, number_unsigned, or number_float - depends on number string | 'H'
- string | string | `S`
- char | string | `C`
- array | array (optimized values are supported) | `[`
- object | object (optimized values are supported) | `{`
-
- @note The mapping is **complete** in the sense that any UBJSON value can
- be converted to a JSON value.
-
- @param[in] i an input in UBJSON format convertible to an input adapter
- @param[in] strict whether to expect the input to be consumed until EOF
- (true by default)
- @param[in] allow_exceptions whether to throw exceptions in case of a
- parse error (optional, true by default)
-
- @return deserialized JSON value; in case of a parse error and
- @a allow_exceptions set to `false`, the return value will be
- value_t::discarded.
-
- @throw parse_error.110 if the given input ends prematurely or the end of
- file was not reached when @a strict was set to true
- @throw parse_error.112 if a parse error occurs
- @throw parse_error.113 if a string could not be parsed successfully
-
- @complexity Linear in the size of the input @a i.
-
- @liveexample{The example shows the deserialization of a byte vector in
- UBJSON format to a JSON value.,from_ubjson}
-
- @sa http://ubjson.org
- @sa see @ref to_ubjson(const basic_json&, const bool, const bool) for the
- analogous serialization
- @sa see @ref from_cbor(InputType&&, const bool, const bool, const cbor_tag_handler_t) for the
- related CBOR format
- @sa see @ref from_msgpack(InputType&&, const bool, const bool) for
- the related MessagePack format
- @sa see @ref from_bson(InputType&&, const bool, const bool) for
- the related BSON format
-
- @since version 3.1.0; added @a allow_exceptions parameter since 3.2.0
- */
+ /// @brief create a JSON value from an input in UBJSON format
+ /// @sa https://json.nlohmann.me/api/basic_json/from_ubjson/
template<typename InputType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json from_ubjson(InputType&& i,
@@ -25505,9 +21229,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res ? result : basic_json(value_t::discarded);
}
- /*!
- @copydoc from_ubjson(InputType&&, const bool, const bool)
- */
+ /// @brief create a JSON value from an input in UBJSON format
+ /// @sa https://json.nlohmann.me/api/basic_json/from_ubjson/
template<typename IteratorType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json from_ubjson(IteratorType first, IteratorType last,
@@ -25545,67 +21268,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res ? result : basic_json(value_t::discarded);
}
-
- /*!
- @brief Create a JSON value from an input in BSON format
-
- Deserializes a given input @a i to a JSON value using the BSON (Binary JSON)
- serialization format.
-
- The library maps BSON record types to JSON value types as follows:
-
- BSON type | BSON marker byte | JSON value type
- --------------- | ---------------- | ---------------------------
- double | 0x01 | number_float
- string | 0x02 | string
- document | 0x03 | object
- array | 0x04 | array
- binary | 0x05 | binary
- undefined | 0x06 | still unsupported
- ObjectId | 0x07 | still unsupported
- boolean | 0x08 | boolean
- UTC Date-Time | 0x09 | still unsupported
- null | 0x0A | null
- Regular Expr. | 0x0B | still unsupported
- DB Pointer | 0x0C | still unsupported
- JavaScript Code | 0x0D | still unsupported
- Symbol | 0x0E | still unsupported
- JavaScript Code | 0x0F | still unsupported
- int32 | 0x10 | number_integer
- Timestamp | 0x11 | still unsupported
- 128-bit decimal float | 0x13 | still unsupported
- Max Key | 0x7F | still unsupported
- Min Key | 0xFF | still unsupported
-
- @warning The mapping is **incomplete**. The unsupported mappings
- are indicated in the table above.
-
- @param[in] i an input in BSON format convertible to an input adapter
- @param[in] strict whether to expect the input to be consumed until EOF
- (true by default)
- @param[in] allow_exceptions whether to throw exceptions in case of a
- parse error (optional, true by default)
-
- @return deserialized JSON value; in case of a parse error and
- @a allow_exceptions set to `false`, the return value will be
- value_t::discarded.
-
- @throw parse_error.114 if an unsupported BSON record type is encountered
-
- @complexity Linear in the size of the input @a i.
-
- @liveexample{The example shows the deserialization of a byte vector in
- BSON format to a JSON value.,from_bson}
-
- @sa http://bsonspec.org/spec.html
- @sa see @ref to_bson(const basic_json&) for the analogous serialization
- @sa see @ref from_cbor(InputType&&, const bool, const bool, const cbor_tag_handler_t) for the
- related CBOR format
- @sa see @ref from_msgpack(InputType&&, const bool, const bool) for
- the related MessagePack format
- @sa see @ref from_ubjson(InputType&&, const bool, const bool) for the
- related UBJSON format
- */
+ /// @brief create a JSON value from an input in BSON format
+ /// @sa https://json.nlohmann.me/api/basic_json/from_bson/
template<typename InputType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json from_bson(InputType&& i,
@@ -25619,9 +21283,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return res ? result : basic_json(value_t::discarded);
}
- /*!
- @copydoc from_bson(InputType&&, const bool, const bool)
- */
+ /// @brief create a JSON value from an input in BSON format
+ /// @sa https://json.nlohmann.me/api/basic_json/from_bson/
template<typename IteratorType>
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json from_bson(IteratorType first, IteratorType last,
@@ -25667,180 +21330,36 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name JSON Pointer functions
/// @{
- /*!
- @brief access specified element via JSON Pointer
-
- Uses a JSON pointer to retrieve a reference to the respective JSON value.
- No bound checking is performed. Similar to @ref operator[](const typename
- object_t::key_type&), `null` values are created in arrays and objects if
- necessary.
-
- In particular:
- - If the JSON pointer points to an object key that does not exist, it
- is created an filled with a `null` value before a reference to it
- is returned.
- - If the JSON pointer points to an array index that does not exist, it
- is created an filled with a `null` value before a reference to it
- is returned. All indices between the current maximum and the given
- index are also filled with `null`.
- - The special value `-` is treated as a synonym for the index past the
- end.
-
- @param[in] ptr a JSON pointer
-
- @return reference to the element pointed to by @a ptr
-
- @complexity Constant.
-
- @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.404 if the JSON pointer can not be resolved
-
- @liveexample{The behavior is shown in the example.,operatorjson_pointer}
-
- @since version 2.0.0
- */
+ /// @brief access specified element via JSON Pointer
+ /// @sa https://json.nlohmann.me/api/basic_json/operator%5B%5D/
reference operator[](const json_pointer& ptr)
{
return ptr.get_unchecked(this);
}
- /*!
- @brief access specified element via JSON Pointer
-
- Uses a JSON pointer to retrieve a reference to the respective JSON value.
- No bound checking is performed. The function does not change the JSON
- value; no `null` values are created. In particular, the special value
- `-` yields an exception.
-
- @param[in] ptr JSON pointer to the desired element
-
- @return const reference to the element pointed to by @a ptr
-
- @complexity Constant.
-
- @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
-
- @liveexample{The behavior is shown in the example.,operatorjson_pointer_const}
-
- @since version 2.0.0
- */
+ /// @brief access specified element via JSON Pointer
+ /// @sa https://json.nlohmann.me/api/basic_json/operator%5B%5D/
const_reference operator[](const json_pointer& ptr) const
{
return ptr.get_unchecked(this);
}
- /*!
- @brief access specified element via JSON Pointer
-
- Returns a reference to the element at with specified JSON pointer @a ptr,
- with bounds checking.
-
- @param[in] ptr JSON pointer to the desired element
-
- @return reference to the element pointed to by @a ptr
-
- @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
- begins with '0'. See example below.
-
- @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
- is not a number. See example below.
-
- @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
- is out of range. See example below.
-
- @throw out_of_range.402 if the array index '-' is used in the passed JSON
- pointer @a ptr. As `at` provides checked access (and no elements are
- implicitly inserted), the index '-' is always invalid. See example below.
-
- @throw out_of_range.403 if the JSON pointer describes a key of an object
- which cannot be found. See example below.
-
- @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
- See example below.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @complexity Constant.
-
- @since version 2.0.0
-
- @liveexample{The behavior is shown in the example.,at_json_pointer}
- */
+ /// @brief access specified element via JSON Pointer
+ /// @sa https://json.nlohmann.me/api/basic_json/at/
reference at(const json_pointer& ptr)
{
return ptr.get_checked(this);
}
- /*!
- @brief access specified element via JSON Pointer
-
- Returns a const reference to the element at with specified JSON pointer @a
- ptr, with bounds checking.
-
- @param[in] ptr JSON pointer to the desired element
-
- @return reference to the element pointed to by @a ptr
-
- @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
- begins with '0'. See example below.
-
- @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
- is not a number. See example below.
-
- @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
- is out of range. See example below.
-
- @throw out_of_range.402 if the array index '-' is used in the passed JSON
- pointer @a ptr. As `at` provides checked access (and no elements are
- implicitly inserted), the index '-' is always invalid. See example below.
-
- @throw out_of_range.403 if the JSON pointer describes a key of an object
- which cannot be found. See example below.
-
- @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
- See example below.
-
- @exceptionsafety Strong guarantee: if an exception is thrown, there are no
- changes in the JSON value.
-
- @complexity Constant.
-
- @since version 2.0.0
-
- @liveexample{The behavior is shown in the example.,at_json_pointer_const}
- */
+ /// @brief access specified element via JSON Pointer
+ /// @sa https://json.nlohmann.me/api/basic_json/at/
const_reference at(const json_pointer& ptr) const
{
return ptr.get_checked(this);
}
- /*!
- @brief return flattened JSON value
-
- The function creates a JSON object whose keys are JSON pointers (see [RFC
- 6901](https://tools.ietf.org/html/rfc6901)) and whose values are all
- primitive. The original JSON value can be restored using the @ref
- unflatten() function.
-
- @return an object that maps JSON pointers to primitive values
-
- @note Empty objects and arrays are flattened to `null` and will not be
- reconstructed correctly by the @ref unflatten() function.
-
- @complexity Linear in the size the JSON value.
-
- @liveexample{The following code shows how a JSON object is flattened to an
- object whose keys consist of JSON pointers.,flatten}
-
- @sa see @ref unflatten() for the reverse function
-
- @since version 2.0.0
- */
+ /// @brief return flattened JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/flatten/
basic_json flatten() const
{
basic_json result(value_t::object);
@@ -25848,36 +21367,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief unflatten a previously flattened JSON value
-
- The function restores the arbitrary nesting of a JSON value that has been
- flattened before using the @ref flatten() function. The JSON value must
- meet certain constraints:
- 1. The value must be an object.
- 2. The keys must be JSON pointers (see
- [RFC 6901](https://tools.ietf.org/html/rfc6901))
- 3. The mapped values must be primitive JSON types.
-
- @return the original JSON from a flattened version
-
- @note Empty objects and arrays are flattened by @ref flatten() to `null`
- values and can not unflattened to their original type. Apart from
- this example, for a JSON value `j`, the following is always true:
- `j == j.flatten().unflatten()`.
-
- @complexity Linear in the size the JSON value.
-
- @throw type_error.314 if value is not an object
- @throw type_error.315 if object values are not primitive
-
- @liveexample{The following code shows how a flattened JSON object is
- unflattened into the original nested JSON object.,unflatten}
-
- @sa see @ref flatten() for the reverse function
-
- @since version 2.0.0
- */
+ /// @brief unflatten a previously flattened JSON value
+ /// @sa https://json.nlohmann.me/api/basic_json/unflatten/
basic_json unflatten() const
{
return json_pointer::unflatten(*this);
@@ -25892,53 +21383,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name JSON Patch functions
/// @{
- /*!
- @brief applies a JSON patch
-
- [JSON Patch](http://jsonpatch.com) defines a JSON document structure for
- expressing a sequence of operations to apply to a JSON) document. With
- this function, a JSON Patch is applied to the current JSON value by
- executing all operations from the patch.
-
- @param[in] json_patch JSON patch document
- @return patched document
-
- @note The application of a patch is atomic: Either all operations succeed
- and the patched document is returned or an exception is thrown. In
- any case, the original value is not changed: the patch is applied
- to a copy of the value.
-
- @throw parse_error.104 if the JSON patch does not consist of an array of
- objects
-
- @throw parse_error.105 if the JSON patch is malformed (e.g., mandatory
- attributes are missing); example: `"operation add must have member path"`
-
- @throw out_of_range.401 if an array index is out of range.
-
- @throw out_of_range.403 if a JSON pointer inside the patch could not be
- resolved successfully in the current JSON value; example: `"key baz not
- found"`
-
- @throw out_of_range.405 if JSON pointer has no parent ("add", "remove",
- "move")
-
- @throw other_error.501 if "test" operation was unsuccessful
-
- @complexity Linear in the size of the JSON value and the length of the
- JSON patch. As usually only a fraction of the JSON value is affected by
- the patch, the complexity can usually be neglected.
-
- @liveexample{The following code shows how a JSON patch is applied to a
- value.,patch}
-
- @sa see @ref diff -- create a JSON patch by comparing two JSON values
-
- @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
- @sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)
-
- @since version 2.0.0
- */
+ /// @brief applies a JSON patch
+ /// @sa https://json.nlohmann.me/api/basic_json/patch/
basic_json patch(const basic_json& json_patch) const
{
// make a working copy to apply the patch to
@@ -26211,39 +21657,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return result;
}
- /*!
- @brief creates a diff as a JSON patch
-
- Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can
- be changed into the value @a target by calling @ref patch function.
-
- @invariant For two JSON values @a source and @a target, the following code
- yields always `true`:
- @code {.cpp}
- source.patch(diff(source, target)) == target;
- @endcode
-
- @note Currently, only `remove`, `add`, and `replace` operations are
- generated.
-
- @param[in] source JSON value to compare from
- @param[in] target JSON value to compare against
- @param[in] path helper value to create JSON pointers
-
- @return a JSON patch to convert the @a source to @a target
-
- @complexity Linear in the lengths of @a source and @a target.
-
- @liveexample{The following code shows how a JSON patch is created as a
- diff for two JSON values.,diff}
-
- @sa see @ref patch -- apply a JSON patch
- @sa see @ref merge_patch -- apply a JSON Merge Patch
-
- @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
-
- @since version 2.0.0
- */
+ /// @brief creates a diff as a JSON patch
+ /// @sa https://json.nlohmann.me/api/basic_json/diff/
JSON_HEDLEY_WARN_UNUSED_RESULT
static basic_json diff(const basic_json& source, const basic_json& target,
const std::string& path = "")
@@ -26281,7 +21696,7 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
++i;
}
- // i now reached the end of at least one array
+ // We now reached the end of at least one array
// in a second pass, traverse the remaining elements
// remove my remaining elements
@@ -26386,48 +21801,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @name JSON Merge Patch functions
/// @{
- /*!
- @brief applies a JSON Merge Patch
-
- The merge patch format is primarily intended for use with the HTTP PATCH
- method as a means of describing a set of modifications to a target
- resource's content. This function applies a merge patch to the current
- JSON value.
-
- The function implements the following algorithm from Section 2 of
- [RFC 7396 (JSON Merge Patch)](https://tools.ietf.org/html/rfc7396):
-
- ```
- define MergePatch(Target, Patch):
- if Patch is an Object:
- if Target is not an Object:
- Target = {} // Ignore the contents and set it to an empty Object
- for each Name/Value pair in Patch:
- if Value is null:
- if Name exists in Target:
- remove the Name/Value pair from Target
- else:
- Target[Name] = MergePatch(Target[Name], Value)
- return Target
- else:
- return Patch
- ```
-
- Thereby, `Target` is the current object; that is, the patch is applied to
- the current value.
-
- @param[in] apply_patch the patch to apply
-
- @complexity Linear in the lengths of @a patch.
-
- @liveexample{The following code shows how a JSON Merge Patch is applied to
- a JSON document.,merge_patch}
-
- @sa see @ref patch -- apply a JSON patch
- @sa [RFC 7396 (JSON Merge Patch)](https://tools.ietf.org/html/rfc7396)
-
- @since version 3.0.0
- */
+ /// @brief applies a JSON Merge Patch
+ /// @sa https://json.nlohmann.me/api/basic_json/merge_patch/
void merge_patch(const basic_json& apply_patch)
{
if (apply_patch.is_object())
@@ -26457,50 +21832,37 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
/// @}
};
-/*!
-@brief user-defined to_string function for JSON values
-
-This function implements a user-defined to_string for JSON objects.
-
-@param[in] j a JSON object
-@return a std::string object
-*/
-
+/// @brief user-defined to_string function for JSON values
+/// @sa https://json.nlohmann.me/api/basic_json/to_string/
NLOHMANN_BASIC_JSON_TPL_DECLARATION
std::string to_string(const NLOHMANN_BASIC_JSON_TPL& j)
{
return j.dump();
}
+
} // namespace nlohmann
///////////////////////
// nonmember support //
///////////////////////
-// specialization of std::swap, and std::hash
-namespace std
+namespace std // NOLINT(cert-dcl58-cpp)
{
-/// hash value for JSON objects
-template<>
-struct hash<nlohmann::json>
+/// @brief hash value for JSON objects
+/// @sa https://json.nlohmann.me/api/basic_json/std_hash/
+NLOHMANN_BASIC_JSON_TPL_DECLARATION
+struct hash<nlohmann::NLOHMANN_BASIC_JSON_TPL>
{
- /*!
- @brief return a hash value for a JSON object
-
- @since version 1.0.0
- */
- std::size_t operator()(const nlohmann::json& j) const
+ std::size_t operator()(const nlohmann::NLOHMANN_BASIC_JSON_TPL& j) const
{
return nlohmann::detail::hash(j);
}
};
-/// specialization for std::less<value_t>
-/// @note: do not remove the space after '<',
-/// see https://github.com/nlohmann/json/pull/679
+// specialization for std::less<value_t>
template<>
-struct less<::nlohmann::detail::value_t>
+struct less< ::nlohmann::detail::value_t> // do not remove the space after '<', see https://github.com/nlohmann/json/pull/679
{
/*!
@brief compare two value_t enum values
@@ -26516,16 +21878,12 @@ struct less<::nlohmann::detail::value_t>
// C++20 prohibit function specialization in the std namespace.
#ifndef JSON_HAS_CPP_20
-/*!
-@brief exchanges the values of two JSON objects
-
-@since version 1.0.0
-*/
-template<>
-inline void swap<nlohmann::json>(nlohmann::json& j1, nlohmann::json& j2) noexcept( // NOLINT(readability-inconsistent-declaration-parameter-name)
- is_nothrow_move_constructible<nlohmann::json>::value&& // NOLINT(misc-redundant-expression)
- is_nothrow_move_assignable<nlohmann::json>::value
- )
+/// @brief exchanges the values of two JSON objects
+/// @sa https://json.nlohmann.me/api/basic_json/std_swap/
+NLOHMANN_BASIC_JSON_TPL_DECLARATION
+inline void swap(nlohmann::NLOHMANN_BASIC_JSON_TPL& j1, nlohmann::NLOHMANN_BASIC_JSON_TPL& j2) noexcept( // NOLINT(readability-inconsistent-declaration-parameter-name)
+ is_nothrow_move_constructible<nlohmann::NLOHMANN_BASIC_JSON_TPL>::value&& // NOLINT(misc-redundant-expression)
+ is_nothrow_move_assignable<nlohmann::NLOHMANN_BASIC_JSON_TPL>::value)
{
j1.swap(j2);
}
@@ -26534,38 +21892,16 @@ inline void swap<nlohmann::json>(nlohmann::json& j1, nlohmann::json& j2) noexcep
} // namespace std
-/*!
-@brief user-defined string literal for JSON values
-
-This operator implements a user-defined string literal for JSON objects. It
-can be used by adding `"_json"` to a string literal and returns a JSON object
-if no parse error occurred.
-
-@param[in] s a string representation of a JSON object
-@param[in] n the length of string @a s
-@return a JSON object
-
-@since version 1.0.0
-*/
+/// @brief user-defined string literal for JSON values
+/// @sa https://json.nlohmann.me/api/basic_json/operator_literal_json/
JSON_HEDLEY_NON_NULL(1)
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
{
return nlohmann::json::parse(s, s + n);
}
-/*!
-@brief user-defined string literal for JSON pointer
-
-This operator implements a user-defined string literal for JSON Pointers. It
-can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
-object if no parse error occurred.
-
-@param[in] s a string representation of a JSON Pointer
-@param[in] n the length of string @a s
-@return a JSON pointer object
-
-@since version 2.0.0
-*/
+/// @brief user-defined string literal for JSON pointer
+/// @sa https://json.nlohmann.me/api/basic_json/operator_literal_json_pointer/
JSON_HEDLEY_NON_NULL(1)
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
{
@@ -26591,6 +21927,8 @@ inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std
#undef JSON_HAS_CPP_14
#undef JSON_HAS_CPP_17
#undef JSON_HAS_CPP_20
+#undef JSON_HAS_FILESYSTEM
+#undef JSON_HAS_EXPERIMENTAL_FILESYSTEM
#undef NLOHMANN_BASIC_JSON_TPL_DECLARATION
#undef NLOHMANN_BASIC_JSON_TPL
#undef JSON_EXPLICIT
diff --git a/include/nlohmann/json_fwd.hpp b/single_include/nlohmann/json_fwd.hpp
index 332227c..2d5ba38 100644
--- a/include/nlohmann/json_fwd.hpp
+++ b/single_include/nlohmann/json_fwd.hpp
@@ -24,6 +24,8 @@ for serialization.
template<typename T = void, typename SFINAE = void>
struct adl_serializer;
+/// a class to store JSON values
+/// @sa https://json.nlohmann.me/api/basic_json/
template<template<typename U, typename V, typename... Args> class ObjectType =
std::map,
template<typename U, typename... Args> class ArrayType = std::vector,
@@ -37,40 +39,24 @@ template<template<typename U, typename V, typename... Args> class ObjectType =
class BinaryType = std::vector<std::uint8_t>>
class basic_json;
-/*!
-@brief JSON Pointer
-
-A JSON pointer defines a string syntax for identifying a specific value
-within a JSON document. It can be used with functions `at` and
-`operator[]`. Furthermore, JSON pointers are the base for JSON patches.
-
-@sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
-
-@since version 2.0.0
-*/
+/// @brief JSON Pointer defines a string syntax for identifying a specific value within a JSON document
+/// @sa https://json.nlohmann.me/api/json_pointer/
template<typename BasicJsonType>
class json_pointer;
/*!
-@brief default JSON class
-
-This type is the default specialization of the @ref basic_json class which
-uses the standard template types.
-
-@since version 1.0.0
+@brief default specialization
+@sa https://json.nlohmann.me/api/json/
*/
using json = basic_json<>;
+/// @brief a minimal map-like container that preserves insertion order
+/// @sa https://json.nlohmann.me/api/ordered_map/
template<class Key, class T, class IgnoredLess, class Allocator>
struct ordered_map;
-/*!
-@brief ordered JSON class
-
-This type preserves the insertion order of object keys.
-
-@since version 3.9.0
-*/
+/// @brief specialization that maintains the insertion order of object keys
+/// @sa https://json.nlohmann.me/api/ordered_json/
using ordered_json = basic_json<nlohmann::ordered_map>;
} // namespace nlohmann
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
new file mode 100644
index 0000000..0897869
--- /dev/null
+++ b/test/CMakeLists.txt
@@ -0,0 +1 @@
+message(FATAL_ERROR "The JSON_CI option is not availablewhen using the nlohmann_json_cmake_fetchcontent repository.") \ No newline at end of file
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-29 16:41:47 +0300