1482 lines
82 KiB
Markdown
1482 lines
82 KiB
Markdown
[](https://github.com/nlohmann/json/releases)
|
||
|
||
[](https://travis-ci.org/nlohmann/json)
|
||
[](https://ci.appveyor.com/project/nlohmann/json)
|
||
[](https://github.com/nlohmann/json/actions?query=workflow%3AUbuntu)
|
||
[](https://github.com/nlohmann/json/actions?query=workflow%3AmacOS)
|
||
[](https://github.com/nlohmann/json/actions?query=workflow%3AWindows)
|
||
[](https://circleci.com/gh/nlohmann/json)
|
||
[](https://coveralls.io/github/nlohmann/json?branch=develop)
|
||
[](https://scan.coverity.com/projects/nlohmann-json)
|
||
[](https://www.codacy.com/app/nlohmann/json?utm_source=github.com&utm_medium=referral&utm_content=nlohmann/json&utm_campaign=Badge_Grade)
|
||
[](https://lgtm.com/projects/g/nlohmann/json/context:cpp)
|
||
[](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:json)
|
||
[](https://wandbox.org/permlink/3lCHrFUZANONKv7a)
|
||
[](http://nlohmann.github.io/json)
|
||
[](https://raw.githubusercontent.com/nlohmann/json/master/LICENSE.MIT)
|
||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fnlohmann%2Fjson?ref=badge_shield)
|
||
[](https://github.com/nlohmann/json/releases)
|
||
[](https://github.com/nlohmann/json/releases)
|
||
[](http://github.com/nlohmann/json/issues)
|
||
[](http://isitmaintained.com/project/nlohmann/json "Average time to resolve an issue")
|
||
[](https://bestpractices.coreinfrastructure.org/projects/289)
|
||
[](https://github.com/sponsors/nlohmann)
|
||
|
||
- [Design goals](#design-goals)
|
||
- [Sponsors](#sponsors)
|
||
- [Integration](#integration)
|
||
- [CMake](#cmake)
|
||
- [Package Managers](#package-managers)
|
||
- [Examples](#examples)
|
||
- [JSON as first-class data type](#json-as-first-class-data-type)
|
||
- [Serialization / Deserialization](#serialization--deserialization)
|
||
- [STL-like access](#stl-like-access)
|
||
- [Conversion from STL containers](#conversion-from-stl-containers)
|
||
- [JSON Pointer and JSON Patch](#json-pointer-and-json-patch)
|
||
- [JSON Merge Patch](#json-merge-patch)
|
||
- [Implicit conversions](#implicit-conversions)
|
||
- [Conversions to/from arbitrary types](#arbitrary-types-conversions)
|
||
- [Specializing enum conversion](#specializing-enum-conversion)
|
||
- [Binary formats (BSON, CBOR, MessagePack, and UBJSON)](#binary-formats-bson-cbor-messagepack-and-ubjson)
|
||
- [Supported compilers](#supported-compilers)
|
||
- [License](#license)
|
||
- [Contact](#contact)
|
||
- [Thanks](#thanks)
|
||
- [Used third-party tools](#used-third-party-tools)
|
||
- [Projects using JSON for Modern C++](#projects-using-json-for-modern-c)
|
||
- [Notes](#notes)
|
||
- [Execute unit tests](#execute-unit-tests)
|
||
|
||
## Design goals
|
||
|
||
There are myriads of [JSON](https://json.org) libraries out there, and each may even have its reason to exist. Our class had these design goals:
|
||
|
||
- **Intuitive syntax**. In languages such as Python, JSON feels like a first class data type. We used all the operator magic of modern C++ to achieve the same feeling in your code. Check out the [examples below](#examples) and you'll know what I mean.
|
||
|
||
- **Trivial integration**. Our whole code consists of a single header file [`json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp). That's it. No library, no subproject, no dependencies, no complex build system. The class is written in vanilla C++11. All in all, everything should require no adjustment of your compiler flags or project settings.
|
||
|
||
- **Serious testing**. Our class is heavily [unit-tested](https://github.com/nlohmann/json/tree/develop/test/src) and covers [100%](https://coveralls.io/r/nlohmann/json) of the code, including all exceptional behavior. Furthermore, we checked with [Valgrind](http://valgrind.org) and the [Clang Sanitizers](https://clang.llvm.org/docs/index.html) that there are no memory leaks. [Google OSS-Fuzz](https://github.com/google/oss-fuzz/tree/master/projects/json) additionally runs fuzz tests against all parsers 24/7, effectively executing billions of tests so far. To maintain high quality, the project is following the [Core Infrastructure Initiative (CII) best practices](https://bestpractices.coreinfrastructure.org/projects/289).
|
||
|
||
Other aspects were not so important to us:
|
||
|
||
- **Memory efficiency**. Each JSON object has an overhead of one pointer (the maximal size of a union) and one enumeration element (1 byte). The default generalization uses the following C++ data types: `std::string` for strings, `int64_t`, `uint64_t` or `double` for numbers, `std::map` for objects, `std::vector` for arrays, and `bool` for Booleans. However, you can template the generalized class `basic_json` to your needs.
|
||
|
||
- **Speed**. There are certainly [faster JSON libraries](https://github.com/miloyip/nativejson-benchmark#parsing-time) out there. However, if your goal is to speed up your development by adding JSON support with a single header, then this library is the way to go. If you know how to use a `std::vector` or `std::map`, you are already set.
|
||
|
||
See the [contribution guidelines](https://github.com/nlohmann/json/blob/master/.github/CONTRIBUTING.md#please-dont) for more information.
|
||
|
||
|
||
## Sponsors
|
||
|
||
You can sponsor this library at [GitHub Sponsors](https://github.com/sponsors/nlohmann).
|
||
|
||
### :label: Named Sponsors
|
||
|
||
- [Michael Hartmann](https://github.com/reFX-Mike)
|
||
- [Stefan Hagen](https://github.com/sthagen)
|
||
- [Steve Sperandeo](https://github.com/homer6)
|
||
|
||
Thanks everyone!
|
||
|
||
|
||
## Integration
|
||
|
||
[`json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp) is the single required file in `single_include/nlohmann` or [released here](https://github.com/nlohmann/json/releases). You need to add
|
||
|
||
```cpp
|
||
#include <nlohmann/json.hpp>
|
||
|
||
// for convenience
|
||
using json = nlohmann::json;
|
||
```
|
||
|
||
to the files you want to process JSON and set the necessary switches to enable C++11 (e.g., `-std=c++11` for GCC and Clang).
|
||
|
||
You can further use file [`include/nlohmann/json_fwd.hpp`](https://github.com/nlohmann/json/blob/develop/include/nlohmann/json_fwd.hpp) for forward-declarations. The installation of json_fwd.hpp (as part of cmake's install step), can be achieved by setting `-DJSON_MultipleHeaders=ON`.
|
||
|
||
### CMake
|
||
|
||
You can also use the `nlohmann_json::nlohmann_json` interface target in CMake. This target populates the appropriate usage requirements for `INTERFACE_INCLUDE_DIRECTORIES` to point to the appropriate include directories and `INTERFACE_COMPILE_FEATURES` for the necessary C++11 flags.
|
||
|
||
#### External
|
||
|
||
To use this library from a CMake project, you can locate it directly with `find_package()` and use the namespaced imported target from the generated package configuration:
|
||
|
||
```cmake
|
||
# CMakeLists.txt
|
||
find_package(nlohmann_json 3.2.0 REQUIRED)
|
||
...
|
||
add_library(foo ...)
|
||
...
|
||
target_link_libraries(foo PRIVATE nlohmann_json::nlohmann_json)
|
||
```
|
||
|
||
The package configuration file, `nlohmann_jsonConfig.cmake`, can be used either from an install tree or directly out of the build tree.
|
||
|
||
#### Embedded
|
||
|
||
To embed the library directly into an existing CMake project, place the entire source tree in a subdirectory and call `add_subdirectory()` in your `CMakeLists.txt` file:
|
||
|
||
```cmake
|
||
# Typically you don't care so much for a third party library's tests to be
|
||
# run from your own project's code.
|
||
set(JSON_BuildTests OFF CACHE INTERNAL "")
|
||
|
||
# If you only include this third party in PRIVATE source files, you do not
|
||
# need to install it when your main project gets installed.
|
||
# set(JSON_Install OFF CACHE INTERNAL "")
|
||
|
||
# Don't use include(nlohmann_json/CMakeLists.txt) since that carries with it
|
||
# unintended consequences that will break the build. It's generally
|
||
# discouraged (although not necessarily well documented as such) to use
|
||
# include(...) for pulling in other CMake projects anyways.
|
||
add_subdirectory(nlohmann_json)
|
||
...
|
||
add_library(foo ...)
|
||
...
|
||
target_link_libraries(foo PRIVATE nlohmann_json::nlohmann_json)
|
||
```
|
||
|
||
##### Embedded (FetchContent)
|
||
|
||
Since CMake v3.11,
|
||
[FetchContent](https://cmake.org/cmake/help/v3.11/module/FetchContent.html) can
|
||
be used to automatically download the repository as a dependency at configure type.
|
||
|
||
Example:
|
||
```cmake
|
||
include(FetchContent)
|
||
|
||
FetchContent_Declare(json
|
||
GIT_REPOSITORY https://github.com/nlohmann/json.git
|
||
GIT_TAG v3.7.3)
|
||
|
||
FetchContent_GetProperties(json)
|
||
if(NOT json_POPULATED)
|
||
FetchContent_Populate(json)
|
||
add_subdirectory(${json_SOURCE_DIR} ${json_BINARY_DIR} EXCLUDE_FROM_ALL)
|
||
endif()
|
||
|
||
target_link_libraries(foo PRIVATE nlohmann_json::nlohmann_json)
|
||
```
|
||
|
||
**Note**: The repository https://github.com/nlohmann/json download size is huge.
|
||
It contains all the dataset used for the benchmarks. You might want to depend on
|
||
a smaller repository. For instance, you might want to replace the URL above by
|
||
https://github.com/ArthurSonzogni/nlohmann_json_cmake_fetchcontent
|
||
|
||
#### Supporting Both
|
||
|
||
To allow your project to support either an externally supplied or an embedded JSON library, you can use a pattern akin to the following:
|
||
|
||
``` cmake
|
||
# Top level CMakeLists.txt
|
||
project(FOO)
|
||
...
|
||
option(FOO_USE_EXTERNAL_JSON "Use an external JSON library" OFF)
|
||
...
|
||
add_subdirectory(thirdparty)
|
||
...
|
||
add_library(foo ...)
|
||
...
|
||
# Note that the namespaced target will always be available regardless of the
|
||
# import method
|
||
target_link_libraries(foo PRIVATE nlohmann_json::nlohmann_json)
|
||
```
|
||
```cmake
|
||
# thirdparty/CMakeLists.txt
|
||
...
|
||
if(FOO_USE_EXTERNAL_JSON)
|
||
find_package(nlohmann_json 3.2.0 REQUIRED)
|
||
else()
|
||
set(JSON_BuildTests OFF CACHE INTERNAL "")
|
||
add_subdirectory(nlohmann_json)
|
||
endif()
|
||
...
|
||
```
|
||
|
||
`thirdparty/nlohmann_json` is then a complete copy of this source tree.
|
||
|
||
### Package Managers
|
||
|
||
:beer: If you are using OS X and [Homebrew](http://brew.sh), just type `brew tap nlohmann/json` and `brew install nlohmann-json` and you're set. If you want the bleeding edge rather than the latest release, use `brew install nlohmann-json --HEAD`.
|
||
|
||
If you are using the [Meson Build System](http://mesonbuild.com), add this source tree as a [meson subproject](https://mesonbuild.com/Subprojects.html#using-a-subproject). You may also use the `include.zip` published in this project's [Releases](https://github.com/nlohmann/json/releases) to reduce the size of the vendored source tree. Alternatively, you can get a wrap file by downloading it from [Meson WrapDB](https://wrapdb.mesonbuild.com/nlohmann_json), or simply use `meson wrap install nlohmann_json`. Please see the meson project for any issues regarding the packaging.
|
||
|
||
The provided meson.build can also be used as an alternative to cmake for installing `nlohmann_json` system-wide in which case a pkg-config file is installed. To use it, simply have your build system require the `nlohmann_json` pkg-config dependency. In Meson, it is preferred to use the [`dependency()`](https://mesonbuild.com/Reference-manual.html#dependency) object with a subproject fallback, rather than using the subproject directly.
|
||
|
||
If you are using [Conan](https://www.conan.io/) to manage your dependencies, merely add `nlohmann_json/x.y.z` to your `conanfile`'s requires, where `x.y.z` is the release version you want to use. Please file issues [here](https://github.com/conan-io/conan-center-index/issues) if you experience problems with the packages.
|
||
|
||
If you are using [Spack](https://www.spack.io/) to manage your dependencies, you can use the [`nlohmann-json` package](https://spack.readthedocs.io/en/latest/package_list.html#nlohmann-json). Please see the [spack project](https://github.com/spack/spack) for any issues regarding the packaging.
|
||
|
||
If you are using [hunter](https://github.com/cpp-pm/hunter) on your project for external dependencies, then you can use the [nlohmann_json package](https://hunter.readthedocs.io/en/latest/packages/pkg/nlohmann_json.html). Please see the hunter project for any issues regarding the packaging.
|
||
|
||
If you are using [Buckaroo](https://buckaroo.pm), you can install this library's module with `buckaroo add github.com/buckaroo-pm/nlohmann-json`. Please file issues [here](https://github.com/buckaroo-pm/nlohmann-json). There is a demo repo [here](https://github.com/njlr/buckaroo-nholmann-json-example).
|
||
|
||
If you are using [vcpkg](https://github.com/Microsoft/vcpkg/) on your project for external dependencies, then you can use the [nlohmann-json package](https://github.com/Microsoft/vcpkg/tree/master/ports/nlohmann-json). Please see the vcpkg project for any issues regarding the packaging.
|
||
|
||
If you are using [cget](http://cget.readthedocs.io/en/latest/), you can install the latest development version with `cget install nlohmann/json`. A specific version can be installed with `cget install nlohmann/json@v3.1.0`. Also, the multiple header version can be installed by adding the `-DJSON_MultipleHeaders=ON` flag (i.e., `cget install nlohmann/json -DJSON_MultipleHeaders=ON`).
|
||
|
||
If you are using [CocoaPods](https://cocoapods.org), you can use the library by adding pod `"nlohmann_json", '~>3.1.2'` to your podfile (see [an example](https://bitbucket.org/benman/nlohmann_json-cocoapod/src/master/)). Please file issues [here](https://bitbucket.org/benman/nlohmann_json-cocoapod/issues?status=new&status=open).
|
||
|
||
If you are using [NuGet](https://www.nuget.org), you can use the package [nlohmann.json](https://www.nuget.org/packages/nlohmann.json/). Please check [this extensive description](https://github.com/nlohmann/json/issues/1132#issuecomment-452250255) on how to use the package. Please files issues [here](https://github.com/hnkb/nlohmann-json-nuget/issues).
|
||
|
||
If you are using [conda](https://conda.io/), you can use the package [nlohmann_json](https://github.com/conda-forge/nlohmann_json-feedstock) from [conda-forge](https://conda-forge.org) executing `conda install -c conda-forge nlohmann_json`. Please file issues [here](https://github.com/conda-forge/nlohmann_json-feedstock/issues).
|
||
|
||
If you are using [MSYS2](http://www.msys2.org/), your can use the [mingw-w64-nlohmann-json](https://packages.msys2.org/base/mingw-w64-nlohmann-json) package, just type `pacman -S mingw-w64-i686-nlohmann-json` or `pacman -S mingw-w64-x86_64-nlohmann-json` for installation. Please file issues [here](https://github.com/msys2/MINGW-packages/issues/new?title=%5Bnlohmann-json%5D) if you experience problems with the packages.
|
||
|
||
If you are using [`build2`](https://build2.org), you can use the [`nlohmann-json`](https://cppget.org/nlohmann-json) package from the public repository http://cppget.org or directly from the [package's sources repository](https://github.com/build2-packaging/nlohmann-json). In your project's `manifest` file, just add `depends: nlohmann-json` (probably with some [version constraints](https://build2.org/build2-toolchain/doc/build2-toolchain-intro.xhtml#guide-add-remove-deps)). If you are not familiar with using dependencies in `build2`, [please read this introduction](https://build2.org/build2-toolchain/doc/build2-toolchain-intro.xhtml).
|
||
Please file issues [here](https://github.com/build2-packaging/nlohmann-json) if you experience problems with the packages.
|
||
|
||
If you are using [`wsjcpp`](http://wsjcpp.org), you can use the command `wsjcpp install "https://github.com/nlohmann/json:develop"` to get the latest version. Note you can change the branch ":develop" to an existing tag or another branch.
|
||
|
||
## Examples
|
||
|
||
Beside the examples below, you may want to check the [documentation](https://nlohmann.github.io/json/) where each function contains a separate code example (e.g., check out [`emplace()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a5338e282d1d02bed389d852dd670d98d.html#a5338e282d1d02bed389d852dd670d98d)). All [example files](https://github.com/nlohmann/json/tree/develop/doc/examples) can be compiled and executed on their own (e.g., file [emplace.cpp](https://github.com/nlohmann/json/blob/develop/doc/examples/emplace.cpp)).
|
||
|
||
### JSON as first-class data type
|
||
|
||
Here are some examples to give you an idea how to use the class.
|
||
|
||
Assume you want to create the JSON object
|
||
|
||
```json
|
||
{
|
||
"pi": 3.141,
|
||
"happy": true,
|
||
"name": "Niels",
|
||
"nothing": null,
|
||
"answer": {
|
||
"everything": 42
|
||
},
|
||
"list": [1, 0, 2],
|
||
"object": {
|
||
"currency": "USD",
|
||
"value": 42.99
|
||
}
|
||
}
|
||
```
|
||
|
||
With this library, you could write:
|
||
|
||
```cpp
|
||
// create an empty structure (null)
|
||
json j;
|
||
|
||
// add a number that is stored as double (note the implicit conversion of j to an object)
|
||
j["pi"] = 3.141;
|
||
|
||
// add a Boolean that is stored as bool
|
||
j["happy"] = true;
|
||
|
||
// add a string that is stored as std::string
|
||
j["name"] = "Niels";
|
||
|
||
// add another null object by passing nullptr
|
||
j["nothing"] = nullptr;
|
||
|
||
// add an object inside the object
|
||
j["answer"]["everything"] = 42;
|
||
|
||
// add an array that is stored as std::vector (using an initializer list)
|
||
j["list"] = { 1, 0, 2 };
|
||
|
||
// add another object (using an initializer list of pairs)
|
||
j["object"] = { {"currency", "USD"}, {"value", 42.99} };
|
||
|
||
// instead, you could also write (which looks very similar to the JSON above)
|
||
json j2 = {
|
||
{"pi", 3.141},
|
||
{"happy", true},
|
||
{"name", "Niels"},
|
||
{"nothing", nullptr},
|
||
{"answer", {
|
||
{"everything", 42}
|
||
}},
|
||
{"list", {1, 0, 2}},
|
||
{"object", {
|
||
{"currency", "USD"},
|
||
{"value", 42.99}
|
||
}}
|
||
};
|
||
```
|
||
|
||
Note that in all these cases, you never need to "tell" the compiler which JSON value type you want to use. If you want to be explicit or express some edge cases, the functions [`json::array()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a9ad7ec0bc1082ed09d10900fbb20a21f.html#a9ad7ec0bc1082ed09d10900fbb20a21f) and [`json::object()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_aaf509a7c029100d292187068f61c99b8.html#aaf509a7c029100d292187068f61c99b8) will help:
|
||
|
||
```cpp
|
||
// a way to express the empty array []
|
||
json empty_array_explicit = json::array();
|
||
|
||
// ways to express the empty object {}
|
||
json empty_object_implicit = json({});
|
||
json empty_object_explicit = json::object();
|
||
|
||
// a way to express an _array_ of key/value pairs [["currency", "USD"], ["value", 42.99]]
|
||
json array_not_object = json::array({ {"currency", "USD"}, {"value", 42.99} });
|
||
```
|
||
|
||
### Serialization / Deserialization
|
||
|
||
#### To/from strings
|
||
|
||
You can create a JSON value (deserialization) by appending `_json` to a string literal:
|
||
|
||
```cpp
|
||
// create object from string literal
|
||
json j = "{ \"happy\": true, \"pi\": 3.141 }"_json;
|
||
|
||
// or even nicer with a raw string literal
|
||
auto j2 = R"(
|
||
{
|
||
"happy": true,
|
||
"pi": 3.141
|
||
}
|
||
)"_json;
|
||
```
|
||
|
||
Note that without appending the `_json` suffix, the passed string literal is not parsed, but just used as JSON string value. That is, `json j = "{ \"happy\": true, \"pi\": 3.141 }"` would just store the string `"{ "happy": true, "pi": 3.141 }"` rather than parsing the actual object.
|
||
|
||
The above example can also be expressed explicitly using [`json::parse()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a265a473e939184aa42655c9ccdf34e58.html#a265a473e939184aa42655c9ccdf34e58):
|
||
|
||
```cpp
|
||
// parse explicitly
|
||
auto j3 = json::parse("{ \"happy\": true, \"pi\": 3.141 }");
|
||
```
|
||
|
||
You can also get a string representation of a JSON value (serialize):
|
||
|
||
```cpp
|
||
// explicit conversion to string
|
||
std::string s = j.dump(); // {"happy":true,"pi":3.141}
|
||
|
||
// serialization with pretty printing
|
||
// pass in the amount of spaces to indent
|
||
std::cout << j.dump(4) << std::endl;
|
||
// {
|
||
// "happy": true,
|
||
// "pi": 3.141
|
||
// }
|
||
```
|
||
|
||
Note the difference between serialization and assignment:
|
||
|
||
```cpp
|
||
// store a string in a JSON value
|
||
json j_string = "this is a string";
|
||
|
||
// retrieve the string value
|
||
auto cpp_string = j_string.get<std::string>();
|
||
// retrieve the string value (alternative when an variable already exists)
|
||
std::string cpp_string2;
|
||
j_string.get_to(cpp_string2);
|
||
|
||
// retrieve the serialized value (explicit JSON serialization)
|
||
std::string serialized_string = j_string.dump();
|
||
|
||
// output of original string
|
||
std::cout << cpp_string << " == " << cpp_string2 << " == " << j_string.get<std::string>() << '\n';
|
||
// output of serialized value
|
||
std::cout << j_string << " == " << serialized_string << std::endl;
|
||
```
|
||
|
||
[`.dump()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a50ec80b02d0f3f51130d4abb5d1cfdc5.html#a50ec80b02d0f3f51130d4abb5d1cfdc5) always returns the serialized value, and [`.get<std::string>()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_aa6602bb24022183ab989439e19345d08.html#aa6602bb24022183ab989439e19345d08) returns the originally stored string value.
|
||
|
||
Note the library only supports UTF-8. When you store strings with different encodings in the library, calling [`dump()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a50ec80b02d0f3f51130d4abb5d1cfdc5.html#a50ec80b02d0f3f51130d4abb5d1cfdc5) may throw an exception unless `json::error_handler_t::replace` or `json::error_handler_t::ignore` are used as error handlers.
|
||
|
||
#### To/from streams (e.g. files, string streams)
|
||
|
||
You can also use streams to serialize and deserialize:
|
||
|
||
```cpp
|
||
// deserialize from standard input
|
||
json j;
|
||
std::cin >> j;
|
||
|
||
// serialize to standard output
|
||
std::cout << j;
|
||
|
||
// the setw manipulator was overloaded to set the indentation for pretty printing
|
||
std::cout << std::setw(4) << j << std::endl;
|
||
```
|
||
|
||
These operators work for any subclasses of `std::istream` or `std::ostream`. Here is the same example with files:
|
||
|
||
```cpp
|
||
// read a JSON file
|
||
std::ifstream i("file.json");
|
||
json j;
|
||
i >> j;
|
||
|
||
// write prettified JSON to another file
|
||
std::ofstream o("pretty.json");
|
||
o << std::setw(4) << j << std::endl;
|
||
```
|
||
|
||
Please note that setting the exception bit for `failbit` is inappropriate for this use case. It will result in program termination due to the `noexcept` specifier in use.
|
||
|
||
#### Read from iterator range
|
||
|
||
You can also parse JSON from an iterator range; that is, from any container accessible by iterators whose content is stored as contiguous byte sequence, for instance a `std::vector<std::uint8_t>`:
|
||
|
||
```cpp
|
||
std::vector<std::uint8_t> v = {'t', 'r', 'u', 'e'};
|
||
json j = json::parse(v.begin(), v.end());
|
||
```
|
||
|
||
You may leave the iterators for the range [begin, end):
|
||
|
||
```cpp
|
||
std::vector<std::uint8_t> v = {'t', 'r', 'u', 'e'};
|
||
json j = json::parse(v);
|
||
```
|
||
|
||
#### SAX interface
|
||
|
||
The library uses a SAX-like interface with the following functions:
|
||
|
||
```cpp
|
||
// called when null is parsed
|
||
bool null();
|
||
|
||
// called when a boolean is parsed; value is passed
|
||
bool boolean(bool val);
|
||
|
||
// called when a signed or unsigned integer number is parsed; value is passed
|
||
bool number_integer(number_integer_t val);
|
||
bool number_unsigned(number_unsigned_t val);
|
||
|
||
// called when a floating-point number is parsed; value and original string is passed
|
||
bool number_float(number_float_t val, const string_t& s);
|
||
|
||
// called when a string is parsed; value is passed and can be safely moved away
|
||
bool string(string_t& val);
|
||
|
||
// called when an object or array begins or ends, resp. The number of elements is passed (or -1 if not known)
|
||
bool start_object(std::size_t elements);
|
||
bool end_object();
|
||
bool start_array(std::size_t elements);
|
||
bool end_array();
|
||
// called when an object key is parsed; value is passed and can be safely moved away
|
||
bool key(string_t& val);
|
||
|
||
// called when a parse error occurs; byte position, the last token, and an exception is passed
|
||
bool parse_error(std::size_t position, const std::string& last_token, const detail::exception& ex);
|
||
```
|
||
|
||
The return value of each function determines whether parsing should proceed.
|
||
|
||
To implement your own SAX handler, proceed as follows:
|
||
|
||
1. Implement the SAX interface in a class. You can use class `nlohmann::json_sax<json>` as base class, but you can also use any class where the functions described above are implemented and public.
|
||
2. Create an object of your SAX interface class, e.g. `my_sax`.
|
||
3. Call `bool json::sax_parse(input, &my_sax)`; where the first parameter can be any input like a string or an input stream and the second parameter is a pointer to your SAX interface.
|
||
|
||
Note the `sax_parse` function only returns a `bool` indicating the result of the last executed SAX event. It does not return a `json` value - it is up to you to decide what to do with the SAX events. Furthermore, no exceptions are thrown in case of a parse error - it is up to you what to do with the exception object passed to your `parse_error` implementation. Internally, the SAX interface is used for the DOM parser (class `json_sax_dom_parser`) as well as the acceptor (`json_sax_acceptor`), see file [`json_sax.hpp`](https://github.com/nlohmann/json/blob/develop/include/nlohmann/detail/input/json_sax.hpp).
|
||
|
||
### STL-like access
|
||
|
||
We designed the JSON class to behave just like an STL container. In fact, it satisfies the [**ReversibleContainer**](https://en.cppreference.com/w/cpp/named_req/ReversibleContainer) requirement.
|
||
|
||
```cpp
|
||
// create an array using push_back
|
||
json j;
|
||
j.push_back("foo");
|
||
j.push_back(1);
|
||
j.push_back(true);
|
||
|
||
// also use emplace_back
|
||
j.emplace_back(1.78);
|
||
|
||
// iterate the array
|
||
for (json::iterator it = j.begin(); it != j.end(); ++it) {
|
||
std::cout << *it << '\n';
|
||
}
|
||
|
||
// range-based for
|
||
for (auto& element : j) {
|
||
std::cout << element << '\n';
|
||
}
|
||
|
||
// getter/setter
|
||
const auto tmp = j[0].get<std::string>();
|
||
j[1] = 42;
|
||
bool foo = j.at(2);
|
||
|
||
// comparison
|
||
j == "[\"foo\", 42, true]"_json; // true
|
||
|
||
// other stuff
|
||
j.size(); // 3 entries
|
||
j.empty(); // false
|
||
j.type(); // json::value_t::array
|
||
j.clear(); // the array is empty again
|
||
|
||
// convenience type checkers
|
||
j.is_null();
|
||
j.is_boolean();
|
||
j.is_number();
|
||
j.is_object();
|
||
j.is_array();
|
||
j.is_string();
|
||
|
||
// create an object
|
||
json o;
|
||
o["foo"] = 23;
|
||
o["bar"] = false;
|
||
o["baz"] = 3.141;
|
||
|
||
// also use emplace
|
||
o.emplace("weather", "sunny");
|
||
|
||
// special iterator member functions for objects
|
||
for (json::iterator it = o.begin(); it != o.end(); ++it) {
|
||
std::cout << it.key() << " : " << it.value() << "\n";
|
||
}
|
||
|
||
// the same code as range for
|
||
for (auto& el : o.items()) {
|
||
std::cout << el.key() << " : " << el.value() << "\n";
|
||
}
|
||
|
||
// even easier with structured bindings (C++17)
|
||
for (auto& [key, value] : o.items()) {
|
||
std::cout << key << " : " << value << "\n";
|
||
}
|
||
|
||
// find an entry
|
||
if (o.contains("foo")) {
|
||
// there is an entry with key "foo"
|
||
}
|
||
|
||
// or via find and an iterator
|
||
if (o.find("foo") != o.end()) {
|
||
// there is an entry with key "foo"
|
||
}
|
||
|
||
// or simpler using count()
|
||
int foo_present = o.count("foo"); // 1
|
||
int fob_present = o.count("fob"); // 0
|
||
|
||
// delete an entry
|
||
o.erase("foo");
|
||
```
|
||
|
||
|
||
### Conversion from STL containers
|
||
|
||
Any sequence container (`std::array`, `std::vector`, `std::deque`, `std::forward_list`, `std::list`) whose values can be used to construct JSON values (e.g., integers, floating point numbers, Booleans, string types, or again STL containers described in this section) can be used to create a JSON array. The same holds for similar associative containers (`std::set`, `std::multiset`, `std::unordered_set`, `std::unordered_multiset`), but in these cases the order of the elements of the array depends on how the elements are ordered in the respective STL container.
|
||
|
||
```cpp
|
||
std::vector<int> c_vector {1, 2, 3, 4};
|
||
json j_vec(c_vector);
|
||
// [1, 2, 3, 4]
|
||
|
||
std::deque<double> c_deque {1.2, 2.3, 3.4, 5.6};
|
||
json j_deque(c_deque);
|
||
// [1.2, 2.3, 3.4, 5.6]
|
||
|
||
std::list<bool> c_list {true, true, false, true};
|
||
json j_list(c_list);
|
||
// [true, true, false, true]
|
||
|
||
std::forward_list<int64_t> c_flist {12345678909876, 23456789098765, 34567890987654, 45678909876543};
|
||
json j_flist(c_flist);
|
||
// [12345678909876, 23456789098765, 34567890987654, 45678909876543]
|
||
|
||
std::array<unsigned long, 4> c_array {{1, 2, 3, 4}};
|
||
json j_array(c_array);
|
||
// [1, 2, 3, 4]
|
||
|
||
std::set<std::string> c_set {"one", "two", "three", "four", "one"};
|
||
json j_set(c_set); // only one entry for "one" is used
|
||
// ["four", "one", "three", "two"]
|
||
|
||
std::unordered_set<std::string> c_uset {"one", "two", "three", "four", "one"};
|
||
json j_uset(c_uset); // only one entry for "one" is used
|
||
// maybe ["two", "three", "four", "one"]
|
||
|
||
std::multiset<std::string> c_mset {"one", "two", "one", "four"};
|
||
json j_mset(c_mset); // both entries for "one" are used
|
||
// maybe ["one", "two", "one", "four"]
|
||
|
||
std::unordered_multiset<std::string> c_umset {"one", "two", "one", "four"};
|
||
json j_umset(c_umset); // both entries for "one" are used
|
||
// maybe ["one", "two", "one", "four"]
|
||
```
|
||
|
||
Likewise, any associative key-value containers (`std::map`, `std::multimap`, `std::unordered_map`, `std::unordered_multimap`) whose keys can construct an `std::string` and whose values can be used to construct JSON values (see examples above) can be used to create a JSON object. Note that in case of multimaps only one key is used in the JSON object and the value depends on the internal order of the STL container.
|
||
|
||
```cpp
|
||
std::map<std::string, int> c_map { {"one", 1}, {"two", 2}, {"three", 3} };
|
||
json j_map(c_map);
|
||
// {"one": 1, "three": 3, "two": 2 }
|
||
|
||
std::unordered_map<const char*, double> c_umap { {"one", 1.2}, {"two", 2.3}, {"three", 3.4} };
|
||
json j_umap(c_umap);
|
||
// {"one": 1.2, "two": 2.3, "three": 3.4}
|
||
|
||
std::multimap<std::string, bool> c_mmap { {"one", true}, {"two", true}, {"three", false}, {"three", true} };
|
||
json j_mmap(c_mmap); // only one entry for key "three" is used
|
||
// maybe {"one": true, "two": true, "three": true}
|
||
|
||
std::unordered_multimap<std::string, bool> c_ummap { {"one", true}, {"two", true}, {"three", false}, {"three", true} };
|
||
json j_ummap(c_ummap); // only one entry for key "three" is used
|
||
// maybe {"one": true, "two": true, "three": true}
|
||
```
|
||
|
||
### JSON Pointer and JSON Patch
|
||
|
||
The library supports **JSON Pointer** ([RFC 6901](https://tools.ietf.org/html/rfc6901)) as alternative means to address structured values. On top of this, **JSON Patch** ([RFC 6902](https://tools.ietf.org/html/rfc6902)) allows to describe differences between two JSON values - effectively allowing patch and diff operations known from Unix.
|
||
|
||
```cpp
|
||
// a JSON value
|
||
json j_original = R"({
|
||
"baz": ["one", "two", "three"],
|
||
"foo": "bar"
|
||
})"_json;
|
||
|
||
// access members with a JSON pointer (RFC 6901)
|
||
j_original["/baz/1"_json_pointer];
|
||
// "two"
|
||
|
||
// a JSON patch (RFC 6902)
|
||
json j_patch = R"([
|
||
{ "op": "replace", "path": "/baz", "value": "boo" },
|
||
{ "op": "add", "path": "/hello", "value": ["world"] },
|
||
{ "op": "remove", "path": "/foo"}
|
||
])"_json;
|
||
|
||
// apply the patch
|
||
json j_result = j_original.patch(j_patch);
|
||
// {
|
||
// "baz": "boo",
|
||
// "hello": ["world"]
|
||
// }
|
||
|
||
// calculate a JSON patch from two JSON values
|
||
json::diff(j_result, j_original);
|
||
// [
|
||
// { "op":" replace", "path": "/baz", "value": ["one", "two", "three"] },
|
||
// { "op": "remove","path": "/hello" },
|
||
// { "op": "add", "path": "/foo", "value": "bar" }
|
||
// ]
|
||
```
|
||
|
||
### JSON Merge Patch
|
||
|
||
The library supports **JSON Merge Patch** ([RFC 7386](https://tools.ietf.org/html/rfc7386)) as a patch format. Instead of using JSON Pointer (see above) to specify values to be manipulated, it describes the changes using a syntax that closely mimics the document being modified.
|
||
|
||
```cpp
|
||
// a JSON value
|
||
json j_document = R"({
|
||
"a": "b",
|
||
"c": {
|
||
"d": "e",
|
||
"f": "g"
|
||
}
|
||
})"_json;
|
||
|
||
// a patch
|
||
json j_patch = R"({
|
||
"a":"z",
|
||
"c": {
|
||
"f": null
|
||
}
|
||
})"_json;
|
||
|
||
// apply the patch
|
||
j_document.merge_patch(j_patch);
|
||
// {
|
||
// "a": "z",
|
||
// "c": {
|
||
// "d": "e"
|
||
// }
|
||
// }
|
||
```
|
||
|
||
### Implicit conversions
|
||
|
||
Supported types can be implicitly converted to JSON values.
|
||
|
||
It is recommended to **NOT USE** implicit conversions **FROM** a JSON value.
|
||
You can find more details about this recommendation [here](https://www.github.com/nlohmann/json/issues/958).
|
||
|
||
```cpp
|
||
// strings
|
||
std::string s1 = "Hello, world!";
|
||
json js = s1;
|
||
auto s2 = js.get<std::string>();
|
||
// NOT RECOMMENDED
|
||
std::string s3 = js;
|
||
std::string s4;
|
||
s4 = js;
|
||
|
||
// Booleans
|
||
bool b1 = true;
|
||
json jb = b1;
|
||
auto b2 = jb.get<bool>();
|
||
// NOT RECOMMENDED
|
||
bool b3 = jb;
|
||
bool b4;
|
||
b4 = jb;
|
||
|
||
// numbers
|
||
int i = 42;
|
||
json jn = i;
|
||
auto f = jn.get<double>();
|
||
// NOT RECOMMENDED
|
||
double f2 = jb;
|
||
double f3;
|
||
f3 = jb;
|
||
|
||
// etc.
|
||
```
|
||
|
||
Note that `char` types are not automatically converted to JSON strings, but to integer numbers. A conversion to a string must be specified explicitly:
|
||
|
||
```cpp
|
||
char ch = 'A'; // ASCII value 65
|
||
json j_default = ch; // stores integer number 65
|
||
json j_string = std::string(1, ch); // stores string "A"
|
||
```
|
||
|
||
### Arbitrary types conversions
|
||
|
||
Every type can be serialized in JSON, not just STL containers and scalar types. Usually, you would do something along those lines:
|
||
|
||
```cpp
|
||
namespace ns {
|
||
// a simple struct to model a person
|
||
struct person {
|
||
std::string name;
|
||
std::string address;
|
||
int age;
|
||
};
|
||
}
|
||
|
||
ns::person p = {"Ned Flanders", "744 Evergreen Terrace", 60};
|
||
|
||
// convert to JSON: copy each value into the JSON object
|
||
json j;
|
||
j["name"] = p.name;
|
||
j["address"] = p.address;
|
||
j["age"] = p.age;
|
||
|
||
// ...
|
||
|
||
// convert from JSON: copy each value from the JSON object
|
||
ns::person p {
|
||
j["name"].get<std::string>(),
|
||
j["address"].get<std::string>(),
|
||
j["age"].get<int>()
|
||
};
|
||
```
|
||
|
||
It works, but that's quite a lot of boilerplate... Fortunately, there's a better way:
|
||
|
||
```cpp
|
||
// create a person
|
||
ns::person p {"Ned Flanders", "744 Evergreen Terrace", 60};
|
||
|
||
// conversion: person -> json
|
||
json j = p;
|
||
|
||
std::cout << j << std::endl;
|
||
// {"address":"744 Evergreen Terrace","age":60,"name":"Ned Flanders"}
|
||
|
||
// conversion: json -> person
|
||
auto p2 = j.get<ns::person>();
|
||
|
||
// that's it
|
||
assert(p == p2);
|
||
```
|
||
|
||
#### Basic usage
|
||
|
||
To make this work with one of your types, you only need to provide two functions:
|
||
|
||
```cpp
|
||
using nlohmann::json;
|
||
|
||
namespace ns {
|
||
void to_json(json& j, const person& p) {
|
||
j = json{{"name", p.name}, {"address", p.address}, {"age", p.age}};
|
||
}
|
||
|
||
void from_json(const json& j, person& p) {
|
||
j.at("name").get_to(p.name);
|
||
j.at("address").get_to(p.address);
|
||
j.at("age").get_to(p.age);
|
||
}
|
||
} // namespace ns
|
||
```
|
||
|
||
That's all! When calling the `json` constructor with your type, your custom `to_json` method will be automatically called.
|
||
Likewise, when calling `get<your_type>()` or `get_to(your_type&)`, the `from_json` method will be called.
|
||
|
||
Some important things:
|
||
|
||
* Those methods **MUST** be in your type's namespace (which can be the global namespace), or the library will not be able to locate them (in this example, they are in namespace `ns`, where `person` is defined).
|
||
* Those methods **MUST** be available (e.g., proper headers must be included) everywhere you use these conversions. Look at [issue 1108](https://github.com/nlohmann/json/issues/1108) for errors that may occur otherwise.
|
||
* When using `get<your_type>()`, `your_type` **MUST** be [DefaultConstructible](https://en.cppreference.com/w/cpp/named_req/DefaultConstructible). (There is a way to bypass this requirement described later.)
|
||
* In function `from_json`, use function [`at()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a93403e803947b86f4da2d1fb3345cf2c.html#a93403e803947b86f4da2d1fb3345cf2c) to access the object values rather than `operator[]`. In case a key does not exist, `at` throws an exception that you can handle, whereas `operator[]` exhibits undefined behavior.
|
||
* You do not need to add serializers or deserializers for STL types like `std::vector`: the library already implements these.
|
||
|
||
|
||
#### How do I convert third-party types?
|
||
|
||
This requires a bit more advanced technique. But first, let's see how this conversion mechanism works:
|
||
|
||
The library uses **JSON Serializers** to convert types to json.
|
||
The default serializer for `nlohmann::json` is `nlohmann::adl_serializer` (ADL means [Argument-Dependent Lookup](https://en.cppreference.com/w/cpp/language/adl)).
|
||
|
||
It is implemented like this (simplified):
|
||
|
||
```cpp
|
||
template <typename T>
|
||
struct adl_serializer {
|
||
static void to_json(json& j, const T& value) {
|
||
// calls the "to_json" method in T's namespace
|
||
}
|
||
|
||
static void from_json(const json& j, T& value) {
|
||
// same thing, but with the "from_json" method
|
||
}
|
||
};
|
||
```
|
||
|
||
This serializer works fine when you have control over the type's namespace. However, what about `boost::optional` or `std::filesystem::path` (C++17)? Hijacking the `boost` namespace is pretty bad, and it's illegal to add something other than template specializations to `std`...
|
||
|
||
To solve this, you need to add a specialization of `adl_serializer` to the `nlohmann` namespace, here's an example:
|
||
|
||
```cpp
|
||
// partial specialization (full specialization works too)
|
||
namespace nlohmann {
|
||
template <typename T>
|
||
struct adl_serializer<boost::optional<T>> {
|
||
static void to_json(json& j, const boost::optional<T>& opt) {
|
||
if (opt == boost::none) {
|
||
j = nullptr;
|
||
} else {
|
||
j = *opt; // this will call adl_serializer<T>::to_json which will
|
||
// find the free function to_json in T's namespace!
|
||
}
|
||
}
|
||
|
||
static void from_json(const json& j, boost::optional<T>& opt) {
|
||
if (j.is_null()) {
|
||
opt = boost::none;
|
||
} else {
|
||
opt = j.get<T>(); // same as above, but with
|
||
// adl_serializer<T>::from_json
|
||
}
|
||
}
|
||
};
|
||
}
|
||
```
|
||
|
||
#### How can I use `get()` for non-default constructible/non-copyable types?
|
||
|
||
There is a way, if your type is [MoveConstructible](https://en.cppreference.com/w/cpp/named_req/MoveConstructible). You will need to specialize the `adl_serializer` as well, but with a special `from_json` overload:
|
||
|
||
```cpp
|
||
struct move_only_type {
|
||
move_only_type() = delete;
|
||
move_only_type(int ii): i(ii) {}
|
||
move_only_type(const move_only_type&) = delete;
|
||
move_only_type(move_only_type&&) = default;
|
||
|
||
int i;
|
||
};
|
||
|
||
namespace nlohmann {
|
||
template <>
|
||
struct adl_serializer<move_only_type> {
|
||
// note: the return type is no longer 'void', and the method only takes
|
||
// one argument
|
||
static move_only_type from_json(const json& j) {
|
||
return {j.get<int>()};
|
||
}
|
||
|
||
// Here's the catch! You must provide a to_json method! Otherwise you
|
||
// will not be able to convert move_only_type to json, since you fully
|
||
// specialized adl_serializer on that type
|
||
static void to_json(json& j, move_only_type t) {
|
||
j = t.i;
|
||
}
|
||
};
|
||
}
|
||
```
|
||
|
||
#### Can I write my own serializer? (Advanced use)
|
||
|
||
Yes. You might want to take a look at [`unit-udt.cpp`](https://github.com/nlohmann/json/blob/develop/test/src/unit-udt.cpp) in the test suite, to see a few examples.
|
||
|
||
If you write your own serializer, you'll need to do a few things:
|
||
|
||
- use a different `basic_json` alias than `nlohmann::json` (the last template parameter of `basic_json` is the `JSONSerializer`)
|
||
- use your `basic_json` alias (or a template parameter) in all your `to_json`/`from_json` methods
|
||
- use `nlohmann::to_json` and `nlohmann::from_json` when you need ADL
|
||
|
||
Here is an example, without simplifications, that only accepts types with a size <= 32, and uses ADL.
|
||
|
||
```cpp
|
||
// You should use void as a second template argument
|
||
// if you don't need compile-time checks on T
|
||
template<typename T, typename SFINAE = typename std::enable_if<sizeof(T) <= 32>::type>
|
||
struct less_than_32_serializer {
|
||
template <typename BasicJsonType>
|
||
static void to_json(BasicJsonType& j, T value) {
|
||
// we want to use ADL, and call the correct to_json overload
|
||
using nlohmann::to_json; // this method is called by adl_serializer,
|
||
// this is where the magic happens
|
||
to_json(j, value);
|
||
}
|
||
|
||
template <typename BasicJsonType>
|
||
static void from_json(const BasicJsonType& j, T& value) {
|
||
// same thing here
|
||
using nlohmann::from_json;
|
||
from_json(j, value);
|
||
}
|
||
};
|
||
```
|
||
|
||
Be **very** careful when reimplementing your serializer, you can stack overflow if you don't pay attention:
|
||
|
||
```cpp
|
||
template <typename T, void>
|
||
struct bad_serializer
|
||
{
|
||
template <typename BasicJsonType>
|
||
static void to_json(BasicJsonType& j, const T& value) {
|
||
// this calls BasicJsonType::json_serializer<T>::to_json(j, value);
|
||
// if BasicJsonType::json_serializer == bad_serializer ... oops!
|
||
j = value;
|
||
}
|
||
|
||
template <typename BasicJsonType>
|
||
static void to_json(const BasicJsonType& j, T& value) {
|
||
// this calls BasicJsonType::json_serializer<T>::from_json(j, value);
|
||
// if BasicJsonType::json_serializer == bad_serializer ... oops!
|
||
value = j.template get<T>(); // oops!
|
||
}
|
||
};
|
||
```
|
||
|
||
### Specializing enum conversion
|
||
|
||
By default, enum values are serialized to JSON as integers. In some cases this could result in undesired behavior. If an enum is modified or re-ordered after data has been serialized to JSON, the later de-serialized JSON data may be undefined or a different enum value than was originally intended.
|
||
|
||
It is possible to more precisely specify how a given enum is mapped to and from JSON as shown below:
|
||
|
||
```cpp
|
||
// example enum type declaration
|
||
enum TaskState {
|
||
TS_STOPPED,
|
||
TS_RUNNING,
|
||
TS_COMPLETED,
|
||
TS_INVALID=-1,
|
||
};
|
||
|
||
// map TaskState values to JSON as strings
|
||
NLOHMANN_JSON_SERIALIZE_ENUM( TaskState, {
|
||
{TS_INVALID, nullptr},
|
||
{TS_STOPPED, "stopped"},
|
||
{TS_RUNNING, "running"},
|
||
{TS_COMPLETED, "completed"},
|
||
})
|
||
```
|
||
|
||
The `NLOHMANN_JSON_SERIALIZE_ENUM()` macro declares a set of `to_json()` / `from_json()` functions for type `TaskState` while avoiding repetition and boilerplate serialization code.
|
||
|
||
**Usage:**
|
||
|
||
```cpp
|
||
// enum to JSON as string
|
||
json j = TS_STOPPED;
|
||
assert(j == "stopped");
|
||
|
||
// json string to enum
|
||
json j3 = "running";
|
||
assert(j3.get<TaskState>() == TS_RUNNING);
|
||
|
||
// undefined json value to enum (where the first map entry above is the default)
|
||
json jPi = 3.14;
|
||
assert(jPi.get<TaskState>() == TS_INVALID );
|
||
```
|
||
|
||
Just as in [Arbitrary Type Conversions](#arbitrary-types-conversions) above,
|
||
- `NLOHMANN_JSON_SERIALIZE_ENUM()` MUST be declared in your enum type's namespace (which can be the global namespace), or the library will not be able to locate it and it will default to integer serialization.
|
||
- It MUST be available (e.g., proper headers must be included) everywhere you use the conversions.
|
||
|
||
Other Important points:
|
||
- When using `get<ENUM_TYPE>()`, undefined JSON values will default to the first pair specified in your map. Select this default pair carefully.
|
||
- If an enum or JSON value is specified more than once in your map, the first matching occurrence from the top of the map will be returned when converting to or from JSON.
|
||
|
||
### Binary formats (BSON, CBOR, MessagePack, and UBJSON)
|
||
|
||
Though JSON is a ubiquitous data format, it is not a very compact format suitable for data exchange, for instance over a network. Hence, the library supports [BSON](http://bsonspec.org) (Binary JSON), [CBOR](http://cbor.io) (Concise Binary Object Representation), [MessagePack](http://msgpack.org), and [UBJSON](http://ubjson.org) (Universal Binary JSON Specification) to efficiently encode JSON values to byte vectors and to decode such vectors.
|
||
|
||
```cpp
|
||
// create a JSON value
|
||
json j = R"({"compact": true, "schema": 0})"_json;
|
||
|
||
// serialize to BSON
|
||
std::vector<std::uint8_t> v_bson = json::to_bson(j);
|
||
|
||
// 0x1B, 0x00, 0x00, 0x00, 0x08, 0x63, 0x6F, 0x6D, 0x70, 0x61, 0x63, 0x74, 0x00, 0x01, 0x10, 0x73, 0x63, 0x68, 0x65, 0x6D, 0x61, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
|
||
|
||
// roundtrip
|
||
json j_from_bson = json::from_bson(v_bson);
|
||
|
||
// serialize to CBOR
|
||
std::vector<std::uint8_t> v_cbor = json::to_cbor(j);
|
||
|
||
// 0xA2, 0x67, 0x63, 0x6F, 0x6D, 0x70, 0x61, 0x63, 0x74, 0xF5, 0x66, 0x73, 0x63, 0x68, 0x65, 0x6D, 0x61, 0x00
|
||
|
||
// roundtrip
|
||
json j_from_cbor = json::from_cbor(v_cbor);
|
||
|
||
// serialize to MessagePack
|
||
std::vector<std::uint8_t> v_msgpack = json::to_msgpack(j);
|
||
|
||
// 0x82, 0xA7, 0x63, 0x6F, 0x6D, 0x70, 0x61, 0x63, 0x74, 0xC3, 0xA6, 0x73, 0x63, 0x68, 0x65, 0x6D, 0x61, 0x00
|
||
|
||
// roundtrip
|
||
json j_from_msgpack = json::from_msgpack(v_msgpack);
|
||
|
||
// serialize to UBJSON
|
||
std::vector<std::uint8_t> v_ubjson = json::to_ubjson(j);
|
||
|
||
// 0x7B, 0x69, 0x07, 0x63, 0x6F, 0x6D, 0x70, 0x61, 0x63, 0x74, 0x54, 0x69, 0x06, 0x73, 0x63, 0x68, 0x65, 0x6D, 0x61, 0x69, 0x00, 0x7D
|
||
|
||
// roundtrip
|
||
json j_from_ubjson = json::from_ubjson(v_ubjson);
|
||
```
|
||
|
||
The library also supports binary types from BSON, CBOR (byte strings), and MessagePack (bin, ext, fixext). They are stored by default as `std::vector<std::uint8_t>` to be processed outside of the library.
|
||
|
||
```cpp
|
||
// CBOR byte string with payload 0xCAFE
|
||
std::vector<std::uint8_t> v = {0x42, 0xCA, 0xFE};
|
||
|
||
// read value
|
||
json j = json::from_cbor(v);
|
||
|
||
// the JSON value has type binary
|
||
j.is_binary(); // true
|
||
|
||
// get reference to stored binary value
|
||
auto& binary = j.get_binary();
|
||
|
||
// the binary value has no subtype (CBOR has no binary subtypes)
|
||
binary.has_subtype(); // false
|
||
|
||
// access std::vector<std::uint8_t> member functions
|
||
binary.size(); // 2
|
||
binary[0]; // 0xCA
|
||
binary[1]; // 0xFE
|
||
|
||
// set subtype to 0x10
|
||
binary.set_subtype(0x10);
|
||
|
||
// serialize to MessagePack
|
||
auto cbor = json::to_msgpack(j); // 0xD5 (fixext2), 0x10, 0xCA, 0xFE
|
||
```
|
||
|
||
|
||
## Supported compilers
|
||
|
||
Though it's 2020 already, the support for C++11 is still a bit sparse. Currently, the following compilers are known to work:
|
||
|
||
- GCC 4.8 - 10.1 (and possibly later)
|
||
- Clang 3.4 - 10.0 (and possibly later)
|
||
- Intel C++ Compiler 17.0.2 (and possibly later)
|
||
- Microsoft Visual C++ 2015 / Build Tools 14.0.25123.0 (and possibly later)
|
||
- Microsoft Visual C++ 2017 / Build Tools 15.5.180.51428 (and possibly later)
|
||
- Microsoft Visual C++ 2019 / Build Tools 16.3.1+1def00d3d (and possibly later)
|
||
|
||
I would be happy to learn about other compilers/versions.
|
||
|
||
Please note:
|
||
|
||
- GCC 4.8 has a bug [57824](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=57824)): multiline raw strings cannot be the arguments to macros. Don't use multiline raw strings directly in macros with this compiler.
|
||
- Android defaults to using very old compilers and C++ libraries. To fix this, add the following to your `Application.mk`. This will switch to the LLVM C++ library, the Clang compiler, and enable C++11 and other features disabled by default.
|
||
|
||
```
|
||
APP_STL := c++_shared
|
||
NDK_TOOLCHAIN_VERSION := clang3.6
|
||
APP_CPPFLAGS += -frtti -fexceptions
|
||
```
|
||
|
||
The code compiles successfully with [Android NDK](https://developer.android.com/ndk/index.html?hl=ml), Revision 9 - 11 (and possibly later) and [CrystaX's Android NDK](https://www.crystax.net/en/android/ndk) version 10.
|
||
|
||
- For GCC running on MinGW or Android SDK, the error `'to_string' is not a member of 'std'` (or similarly, for `strtod` or `strtof`) may occur. Note this is not an issue with the code, but rather with the compiler itself. On Android, see above to build with a newer environment. For MinGW, please refer to [this site](http://tehsausage.com/mingw-to-string) and [this discussion](https://github.com/nlohmann/json/issues/136) for information on how to fix this bug. For Android NDK using `APP_STL := gnustl_static`, please refer to [this discussion](https://github.com/nlohmann/json/issues/219).
|
||
|
||
- Unsupported versions of GCC and Clang are rejected by `#error` directives. This can be switched off by defining `JSON_SKIP_UNSUPPORTED_COMPILER_CHECK`. Note that you can expect no support in this case.
|
||
|
||
The following compilers are currently used in continuous integration at [Travis](https://travis-ci.org/nlohmann/json), [AppVeyor](https://ci.appveyor.com/project/nlohmann/json), [GitHub Actions](https://github.com/nlohmann/json/actions), and [CircleCI](https://circleci.com/gh/nlohmann/json):
|
||
|
||
| Compiler | Operating System | CI Provider |
|
||
|-----------------------------------------------------------------|--------------------|----------------|
|
||
| Apple Clang 9.1.0 (clang-902.0.39.1); Xcode 9.3 | macOS 10.13.3 | Travis |
|
||
| Apple Clang 9.1.0 (clang-902.0.39.2); Xcode 9.4.1 | macOS 10.13.6 | Travis |
|
||
| Apple Clang 10.0.0 (clang-1000.11.45.2); Xcode 10.0 | macOS 10.13.6 | Travis |
|
||
| Apple Clang 10.0.0 (clang-1000.11.45.5); Xcode 10.1 | macOS 10.13.6 | Travis |
|
||
| Apple Clang 10.0.1 (clang-1001.0.46.4); Xcode 10.2.1 | macOS 10.14.4 | Travis |
|
||
| Apple Clang 11.0.0 (clang-1100.0.33.12); Xcode 11.2.1 | macOS 10.14.6 | Travis |
|
||
| Apple Clang 11.0.3 (clang-1103.0.32.59); Xcode 11.4.1 | macOS 10.15.4 | GitHub Actions |
|
||
| Clang 3.5.0 (3.5.0-4ubuntu2~trusty2) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 3.6.2 (3.6.2-svn240577-1~exp1) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 3.7.1 (3.7.1-svn253571-1~exp1) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 3.8.0 (3.8.0-2ubuntu3~trusty5) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 3.9.1 (3.9.1-4ubuntu3~14.04.3) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 4.0.1 (4.0.1-svn305264-1~exp1) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 5.0.2 (version 5.0.2-svn328729-1~exp1~20180509123505.100) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 6.0.1 (6.0.1-svn334776-1~exp1~20190309042707.121) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 7.1.0 (7.1.0-svn353565-1~exp1~20190419134007.64) | Ubuntu 14.04.5 LTS | Travis |
|
||
| Clang 7.5.0 (Ubuntu 7.5.0-3ubuntu1~18.04) | Ubuntu 18.04.4 LTS | Travis |
|
||
| GCC 4.8.5 (Ubuntu 4.8.5-4ubuntu8~14.04.2) | Ubuntu 14.04.5 LTS | Travis |
|
||
| GCC 4.9.4 (Ubuntu 4.9.4-2ubuntu1~14.04.1) | Ubuntu 14.04.5 LTS | Travis |
|
||
| GCC 5.5.0 (Ubuntu 5.5.0-12ubuntu1~14.04) | Ubuntu 14.04.5 LTS | Travis |
|
||
| GCC 6.3.0 (Debian 6.3.0-18+deb9u1) | Debian 9 | Circle CI |
|
||
| GCC 6.5.0 (Ubuntu 6.5.0-2ubuntu1~14.04.1) | Ubuntu 14.04.5 LTS | Travis |
|
||
| GCC 7.3.0 (x86_64-posix-seh-rev0, Built by MinGW-W64 project) | Windows-6.3.9600 | AppVeyor |
|
||
| GCC 7.5.0 (Ubuntu 7.5.0-3ubuntu1~14.04.1) | Ubuntu 14.04.5 LTS | Travis |
|
||
| GCC 7.5.0 (Ubuntu 7.5.0-3ubuntu1~18.04) | Ubuntu 18.04.4 LTS | GitHub Actions |
|
||
| GCC 8.4.0 (Ubuntu 8.4.0-1ubuntu1~14.04) | Ubuntu 14.04.5 LTS | Travis |
|
||
| GCC 9.3.0 (Ubuntu 9.3.0-11ubuntu0~14.04) | Ubuntu 14.04.5 LTS | Travis |
|
||
| GCC 10.1.0 (Arch Linux latest) | Arch Linux | Circle CI |
|
||
| MSVC 19.0.24241.7 (Build Engine version 14.0.25420.1) | Windows-6.3.9600 | AppVeyor |
|
||
| MSVC 19.16.27035.0 (15.9.21+g9802d43bc3 for .NET Framework) | Windows-10.0.14393 | AppVeyor |
|
||
| MSVC 19.25.28614.0 (Build Engine version 16.5.0+d4cbfca49 for .NET Framework) | Windows-10.0.17763 | AppVeyor |
|
||
| MSVC 19.25.28614.0 (Build Engine version 16.5.0+d4cbfca49 for .NET Framework) | Windows-10.0.17763 | GitHub Actions |
|
||
|
||
## License
|
||
|
||
<img align="right" src="http://opensource.org/trademarks/opensource/OSI-Approved-License-100x137.png">
|
||
|
||
The class is licensed under the [MIT License](http://opensource.org/licenses/MIT):
|
||
|
||
Copyright © 2013-2019 [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 in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||
|
||
* * *
|
||
|
||
The class contains the UTF-8 Decoder from Bjoern Hoehrmann which is licensed under the [MIT License](http://opensource.org/licenses/MIT) (see above). Copyright © 2008-2009 [Björn Hoehrmann](http://bjoern.hoehrmann.de/) <bjoern@hoehrmann.de>
|
||
|
||
The class contains a slightly modified version of the Grisu2 algorithm from Florian Loitsch which is licensed under the [MIT License](http://opensource.org/licenses/MIT) (see above). Copyright © 2009 [Florian Loitsch](http://florian.loitsch.com/)
|
||
|
||
The class contains a copy of [Hedley](https://nemequ.github.io/hedley/) from Evan Nemerson which is licensed as [CC0-1.0](http://creativecommons.org/publicdomain/zero/1.0/).
|
||
|
||
## Contact
|
||
|
||
If you have questions regarding the library, I would like to invite you to [open an issue at GitHub](https://github.com/nlohmann/json/issues/new/choose). Please describe your request, problem, or question as detailed as possible, and also mention the version of the library you are using as well as the version of your compiler and operating system. Opening an issue at GitHub allows other users and contributors to this library to collaborate. For instance, I have little experience with MSVC, and most issues in this regard have been solved by a growing community. If you have a look at the [closed issues](https://github.com/nlohmann/json/issues?q=is%3Aissue+is%3Aclosed), you will see that we react quite timely in most cases.
|
||
|
||
Only if your request would contain confidential information, please [send me an email](mailto:mail@nlohmann.me). For encrypted messages, please use [this key](https://keybase.io/nlohmann/pgp_keys.asc).
|
||
|
||
## Security
|
||
|
||
[Commits by Niels Lohmann](https://github.com/nlohmann/json/commits) and [releases](https://github.com/nlohmann/json/releases) are signed with this [PGP Key](https://keybase.io/nlohmann/pgp_keys.asc?fingerprint=797167ae41c0a6d9232e48457f3cea63ae251b69).
|
||
|
||
## Thanks
|
||
|
||
I deeply appreciate the help of the following people.
|
||
|
||
<img src="https://raw.githubusercontent.com/nlohmann/json/develop/doc/avatars.png" align="right">
|
||
|
||
- [Teemperor](https://github.com/Teemperor) implemented CMake support and lcov integration, realized escape and Unicode handling in the string parser, and fixed the JSON serialization.
|
||
- [elliotgoodrich](https://github.com/elliotgoodrich) fixed an issue with double deletion in the iterator classes.
|
||
- [kirkshoop](https://github.com/kirkshoop) made the iterators of the class composable to other libraries.
|
||
- [wancw](https://github.com/wanwc) fixed a bug that hindered the class to compile with Clang.
|
||
- Tomas Åblad found a bug in the iterator implementation.
|
||
- [Joshua C. Randall](https://github.com/jrandall) fixed a bug in the floating-point serialization.
|
||
- [Aaron Burghardt](https://github.com/aburgh) implemented code to parse streams incrementally. Furthermore, he greatly improved the parser class by allowing the definition of a filter function to discard undesired elements while parsing.
|
||
- [Daniel Kopeček](https://github.com/dkopecek) fixed a bug in the compilation with GCC 5.0.
|
||
- [Florian Weber](https://github.com/Florianjw) fixed a bug in and improved the performance of the comparison operators.
|
||
- [Eric Cornelius](https://github.com/EricMCornelius) pointed out a bug in the handling with NaN and infinity values. He also improved the performance of the string escaping.
|
||
- [易思龙](https://github.com/likebeta) implemented a conversion from anonymous enums.
|
||
- [kepkin](https://github.com/kepkin) patiently pushed forward the support for Microsoft Visual studio.
|
||
- [gregmarr](https://github.com/gregmarr) simplified the implementation of reverse iterators and helped with numerous hints and improvements. In particular, he pushed forward the implementation of user-defined types.
|
||
- [Caio Luppi](https://github.com/caiovlp) fixed a bug in the Unicode handling.
|
||
- [dariomt](https://github.com/dariomt) fixed some typos in the examples.
|
||
- [Daniel Frey](https://github.com/d-frey) cleaned up some pointers and implemented exception-safe memory allocation.
|
||
- [Colin Hirsch](https://github.com/ColinH) took care of a small namespace issue.
|
||
- [Huu Nguyen](https://github.com/whoshuu) correct a variable name in the documentation.
|
||
- [Silverweed](https://github.com/silverweed) overloaded `parse()` to accept an rvalue reference.
|
||
- [dariomt](https://github.com/dariomt) fixed a subtlety in MSVC type support and implemented the `get_ref()` function to get a reference to stored values.
|
||
- [ZahlGraf](https://github.com/ZahlGraf) added a workaround that allows compilation using Android NDK.
|
||
- [whackashoe](https://github.com/whackashoe) replaced a function that was marked as unsafe by Visual Studio.
|
||
- [406345](https://github.com/406345) fixed two small warnings.
|
||
- [Glen Fernandes](https://github.com/glenfe) noted a potential portability problem in the `has_mapped_type` function.
|
||
- [Corbin Hughes](https://github.com/nibroc) fixed some typos in the contribution guidelines.
|
||
- [twelsby](https://github.com/twelsby) fixed the array subscript operator, an issue that failed the MSVC build, and floating-point parsing/dumping. He further added support for unsigned integer numbers and implemented better roundtrip support for parsed numbers.
|
||
- [Volker Diels-Grabsch](https://github.com/vog) fixed a link in the README file.
|
||
- [msm-](https://github.com/msm-) added support for American Fuzzy Lop.
|
||
- [Annihil](https://github.com/Annihil) fixed an example in the README file.
|
||
- [Themercee](https://github.com/Themercee) noted a wrong URL in the README file.
|
||
- [Lv Zheng](https://github.com/lv-zheng) fixed a namespace issue with `int64_t` and `uint64_t`.
|
||
- [abc100m](https://github.com/abc100m) analyzed the issues with GCC 4.8 and proposed a [partial solution](https://github.com/nlohmann/json/pull/212).
|
||
- [zewt](https://github.com/zewt) added useful notes to the README file about Android.
|
||
- [Róbert Márki](https://github.com/robertmrk) added a fix to use move iterators and improved the integration via CMake.
|
||
- [Chris Kitching](https://github.com/ChrisKitching) cleaned up the CMake files.
|
||
- [Tom Needham](https://github.com/06needhamt) fixed a subtle bug with MSVC 2015 which was also proposed by [Michael K.](https://github.com/Epidal).
|
||
- [Mário Feroldi](https://github.com/thelostt) fixed a small typo.
|
||
- [duncanwerner](https://github.com/duncanwerner) found a really embarrassing performance regression in the 2.0.0 release.
|
||
- [Damien](https://github.com/dtoma) fixed one of the last conversion warnings.
|
||
- [Thomas Braun](https://github.com/t-b) fixed a warning in a test case.
|
||
- [Théo DELRIEU](https://github.com/theodelrieu) patiently and constructively oversaw the long way toward [iterator-range parsing](https://github.com/nlohmann/json/issues/290). He also implemented the magic behind the serialization/deserialization of user-defined types and split the single header file into smaller chunks.
|
||
- [Stefan](https://github.com/5tefan) fixed a minor issue in the documentation.
|
||
- [Vasil Dimov](https://github.com/vasild) fixed the documentation regarding conversions from `std::multiset`.
|
||
- [ChristophJud](https://github.com/ChristophJud) overworked the CMake files to ease project inclusion.
|
||
- [Vladimir Petrigo](https://github.com/vpetrigo) made a SFINAE hack more readable and added Visual Studio 17 to the build matrix.
|
||
- [Denis Andrejew](https://github.com/seeekr) fixed a grammar issue in the README file.
|
||
- [Pierre-Antoine Lacaze](https://github.com/palacaze) found a subtle bug in the `dump()` function.
|
||
- [TurpentineDistillery](https://github.com/TurpentineDistillery) pointed to [`std::locale::classic()`](https://en.cppreference.com/w/cpp/locale/locale/classic) to avoid too much locale joggling, found some nice performance improvements in the parser, improved the benchmarking code, and realized locale-independent number parsing and printing.
|
||
- [cgzones](https://github.com/cgzones) had an idea how to fix the Coverity scan.
|
||
- [Jared Grubb](https://github.com/jaredgrubb) silenced a nasty documentation warning.
|
||
- [Yixin Zhang](https://github.com/qwename) fixed an integer overflow check.
|
||
- [Bosswestfalen](https://github.com/Bosswestfalen) merged two iterator classes into a smaller one.
|
||
- [Daniel599](https://github.com/Daniel599) helped to get Travis execute the tests with Clang's sanitizers.
|
||
- [Jonathan Lee](https://github.com/vjon) fixed an example in the README file.
|
||
- [gnzlbg](https://github.com/gnzlbg) supported the implementation of user-defined types.
|
||
- [Alexej Harm](https://github.com/qis) helped to get the user-defined types working with Visual Studio.
|
||
- [Jared Grubb](https://github.com/jaredgrubb) supported the implementation of user-defined types.
|
||
- [EnricoBilla](https://github.com/EnricoBilla) noted a typo in an example.
|
||
- [Martin Hořeňovský](https://github.com/horenmar) found a way for a 2x speedup for the compilation time of the test suite.
|
||
- [ukhegg](https://github.com/ukhegg) found proposed an improvement for the examples section.
|
||
- [rswanson-ihi](https://github.com/rswanson-ihi) noted a typo in the README.
|
||
- [Mihai Stan](https://github.com/stanmihai4) fixed a bug in the comparison with `nullptr`s.
|
||
- [Tushar Maheshwari](https://github.com/tusharpm) added [cotire](https://github.com/sakra/cotire) support to speed up the compilation.
|
||
- [TedLyngmo](https://github.com/TedLyngmo) noted a typo in the README, removed unnecessary bit arithmetic, and fixed some `-Weffc++` warnings.
|
||
- [Krzysztof Woś](https://github.com/krzysztofwos) made exceptions more visible.
|
||
- [ftillier](https://github.com/ftillier) fixed a compiler warning.
|
||
- [tinloaf](https://github.com/tinloaf) made sure all pushed warnings are properly popped.
|
||
- [Fytch](https://github.com/Fytch) found a bug in the documentation.
|
||
- [Jay Sistar](https://github.com/Type1J) implemented a Meson build description.
|
||
- [Henry Lee](https://github.com/HenryRLee) fixed a warning in ICC and improved the iterator implementation.
|
||
- [Vincent Thiery](https://github.com/vthiery) maintains a package for the Conan package manager.
|
||
- [Steffen](https://github.com/koemeet) fixed a potential issue with MSVC and `std::min`.
|
||
- [Mike Tzou](https://github.com/Chocobo1) fixed some typos.
|
||
- [amrcode](https://github.com/amrcode) noted a misleading documentation about comparison of floats.
|
||
- [Oleg Endo](https://github.com/olegendo) reduced the memory consumption by replacing `<iostream>` with `<iosfwd>`.
|
||
- [dan-42](https://github.com/dan-42) cleaned up the CMake files to simplify including/reusing of the library.
|
||
- [Nikita Ofitserov](https://github.com/himikof) allowed for moving values from initializer lists.
|
||
- [Greg Hurrell](https://github.com/wincent) fixed a typo.
|
||
- [Dmitry Kukovinets](https://github.com/DmitryKuk) fixed a typo.
|
||
- [kbthomp1](https://github.com/kbthomp1) fixed an issue related to the Intel OSX compiler.
|
||
- [Markus Werle](https://github.com/daixtrose) fixed a typo.
|
||
- [WebProdPP](https://github.com/WebProdPP) fixed a subtle error in a precondition check.
|
||
- [Alex](https://github.com/leha-bot) noted an error in a code sample.
|
||
- [Tom de Geus](https://github.com/tdegeus) reported some warnings with ICC and helped fixing them.
|
||
- [Perry Kundert](https://github.com/pjkundert) simplified reading from input streams.
|
||
- [Sonu Lohani](https://github.com/sonulohani) fixed a small compilation error.
|
||
- [Jamie Seward](https://github.com/jseward) fixed all MSVC warnings.
|
||
- [Nate Vargas](https://github.com/eld00d) added a Doxygen tag file.
|
||
- [pvleuven](https://github.com/pvleuven) helped fixing a warning in ICC.
|
||
- [Pavel](https://github.com/crea7or) helped fixing some warnings in MSVC.
|
||
- [Jamie Seward](https://github.com/jseward) avoided unnecessary string copies in `find()` and `count()`.
|
||
- [Mitja](https://github.com/Itja) fixed some typos.
|
||
- [Jorrit Wronski](https://github.com/jowr) updated the Hunter package links.
|
||
- [Matthias Möller](https://github.com/TinyTinni) added a `.natvis` for the MSVC debug view.
|
||
- [bogemic](https://github.com/bogemic) fixed some C++17 deprecation warnings.
|
||
- [Eren Okka](https://github.com/erengy) fixed some MSVC warnings.
|
||
- [abolz](https://github.com/abolz) integrated the Grisu2 algorithm for proper floating-point formatting, allowing more roundtrip checks to succeed.
|
||
- [Vadim Evard](https://github.com/Pipeliner) fixed a Markdown issue in the README.
|
||
- [zerodefect](https://github.com/zerodefect) fixed a compiler warning.
|
||
- [Kert](https://github.com/kaidokert) allowed to template the string type in the serialization and added the possibility to override the exceptional behavior.
|
||
- [mark-99](https://github.com/mark-99) helped fixing an ICC error.
|
||
- [Patrik Huber](https://github.com/patrikhuber) fixed links in the README file.
|
||
- [johnfb](https://github.com/johnfb) found a bug in the implementation of CBOR's indefinite length strings.
|
||
- [Paul Fultz II](https://github.com/pfultz2) added a note on the cget package manager.
|
||
- [Wilson Lin](https://github.com/wla80) made the integration section of the README more concise.
|
||
- [RalfBielig](https://github.com/ralfbielig) detected and fixed a memory leak in the parser callback.
|
||
- [agrianius](https://github.com/agrianius) allowed to dump JSON to an alternative string type.
|
||
- [Kevin Tonon](https://github.com/ktonon) overworked the C++11 compiler checks in CMake.
|
||
- [Axel Huebl](https://github.com/ax3l) simplified a CMake check and added support for the [Spack package manager](https://spack.io).
|
||
- [Carlos O'Ryan](https://github.com/coryan) fixed a typo.
|
||
- [James Upjohn](https://github.com/jammehcow) fixed a version number in the compilers section.
|
||
- [Chuck Atkins](https://github.com/chuckatkins) adjusted the CMake files to the CMake packaging guidelines and provided documentation for the CMake integration.
|
||
- [Jan Schöppach](https://github.com/dns13) fixed a typo.
|
||
- [martin-mfg](https://github.com/martin-mfg) fixed a typo.
|
||
- [Matthias Möller](https://github.com/TinyTinni) removed the dependency from `std::stringstream`.
|
||
- [agrianius](https://github.com/agrianius) added code to use alternative string implementations.
|
||
- [Daniel599](https://github.com/Daniel599) allowed to use more algorithms with the `items()` function.
|
||
- [Julius Rakow](https://github.com/jrakow) fixed the Meson include directory and fixed the links to [cppreference.com](cppreference.com).
|
||
- [Sonu Lohani](https://github.com/sonulohani) fixed the compilation with MSVC 2015 in debug mode.
|
||
- [grembo](https://github.com/grembo) fixed the test suite and re-enabled several test cases.
|
||
- [Hyeon Kim](https://github.com/simnalamburt) introduced the macro `JSON_INTERNAL_CATCH` to control the exception handling inside the library.
|
||
- [thyu](https://github.com/thyu) fixed a compiler warning.
|
||
- [David Guthrie](https://github.com/LEgregius) fixed a subtle compilation error with Clang 3.4.2.
|
||
- [Dennis Fischer](https://github.com/dennisfischer) allowed to call `find_package` without installing the library.
|
||
- [Hyeon Kim](https://github.com/simnalamburt) fixed an issue with a double macro definition.
|
||
- [Ben Berman](https://github.com/rivertam) made some error messages more understandable.
|
||
- [zakalibit](https://github.com/zakalibit) fixed a compilation problem with the Intel C++ compiler.
|
||
- [mandreyel](https://github.com/mandreyel) fixed a compilation problem.
|
||
- [Kostiantyn Ponomarenko](https://github.com/koponomarenko) added version and license information to the Meson build file.
|
||
- [Henry Schreiner](https://github.com/henryiii) added support for GCC 4.8.
|
||
- [knilch](https://github.com/knilch0r) made sure the test suite does not stall when run in the wrong directory.
|
||
- [Antonio Borondo](https://github.com/antonioborondo) fixed an MSVC 2017 warning.
|
||
- [Dan Gendreau](https://github.com/dgendreau) implemented the `NLOHMANN_JSON_SERIALIZE_ENUM` macro to quickly define a enum/JSON mapping.
|
||
- [efp](https://github.com/efp) added line and column information to parse errors.
|
||
- [julian-becker](https://github.com/julian-becker) added BSON support.
|
||
- [Pratik Chowdhury](https://github.com/pratikpc) added support for structured bindings.
|
||
- [David Avedissian](https://github.com/davedissian) added support for Clang 5.0.1 (PS4 version).
|
||
- [Jonathan Dumaresq](https://github.com/dumarjo) implemented an input adapter to read from `FILE*`.
|
||
- [kjpus](https://github.com/kjpus) fixed a link in the documentation.
|
||
- [Manvendra Singh](https://github.com/manu-chroma) fixed a typo in the documentation.
|
||
- [ziggurat29](https://github.com/ziggurat29) fixed an MSVC warning.
|
||
- [Sylvain Corlay](https://github.com/SylvainCorlay) added code to avoid an issue with MSVC.
|
||
- [mefyl](https://github.com/mefyl) fixed a bug when JSON was parsed from an input stream.
|
||
- [Millian Poquet](https://github.com/mpoquet) allowed to install the library via Meson.
|
||
- [Michael Behrns-Miller](https://github.com/moodboom) found an issue with a missing namespace.
|
||
- [Nasztanovics Ferenc](https://github.com/naszta) fixed a compilation issue with libc 2.12.
|
||
- [Andreas Schwab](https://github.com/andreas-schwab) fixed the endian conversion.
|
||
- [Mark-Dunning](https://github.com/Mark-Dunning) fixed a warning in MSVC.
|
||
- [Gareth Sylvester-Bradley](https://github.com/garethsb-sony) added `operator/` for JSON Pointers.
|
||
- [John-Mark](https://github.com/johnmarkwayve) noted a missing header.
|
||
- [Vitaly Zaitsev](https://github.com/xvitaly) fixed compilation with GCC 9.0.
|
||
- [Laurent Stacul](https://github.com/stac47) fixed compilation with GCC 9.0.
|
||
- [Ivor Wanders](https://github.com/iwanders) helped reducing the CMake requirement to version 3.1.
|
||
- [njlr](https://github.com/njlr) updated the Buckaroo instructions.
|
||
- [Lion](https://github.com/lieff) fixed a compilation issue with GCC 7 on CentOS.
|
||
- [Isaac Nickaein](https://github.com/nickaein) improved the integer serialization performance and implemented the `contains()` function.
|
||
- [past-due](https://github.com/past-due) suppressed an unfixable warning.
|
||
- [Elvis Oric](https://github.com/elvisoric) improved Meson support.
|
||
- [Matěj Plch](https://github.com/Afforix) fixed an example in the README.
|
||
- [Mark Beckwith](https://github.com/wythe) fixed a typo.
|
||
- [scinart](https://github.com/scinart) fixed bug in the serializer.
|
||
- [Patrick Boettcher](https://github.com/pboettch) implemented `push_back()` and `pop_back()` for JSON Pointers.
|
||
- [Bruno Oliveira](https://github.com/nicoddemus) added support for Conda.
|
||
- [Michele Caini](https://github.com/skypjack) fixed links in the README.
|
||
- [Hani](https://github.com/hnkb) documented how to install the library with NuGet.
|
||
- [Mark Beckwith](https://github.com/wythe) fixed a typo.
|
||
- [yann-morin-1998](https://github.com/yann-morin-1998) helped reducing the CMake requirement to version 3.1.
|
||
- [Konstantin Podsvirov](https://github.com/podsvirov) maintains a package for the MSYS2 software distro.
|
||
- [remyabel](https://github.com/remyabel) added GNUInstallDirs to the CMake files.
|
||
- [Taylor Howard](https://github.com/taylorhoward92) fixed a unit test.
|
||
- [Gabe Ron](https://github.com/Macr0Nerd) implemented the `to_string` method.
|
||
- [Watal M. Iwasaki](https://github.com/heavywatal) fixed a Clang warning.
|
||
- [Viktor Kirilov](https://github.com/onqtam) switched the unit tests from [Catch](https://github.com/philsquared/Catch) to [doctest](https://github.com/onqtam/doctest)
|
||
- [Juncheng E](https://github.com/ejcjason) fixed a typo.
|
||
- [tete17](https://github.com/tete17) fixed a bug in the `contains` function.
|
||
- [Xav83](https://github.com/Xav83) fixed some cppcheck warnings.
|
||
- [0xflotus](https://github.com/0xflotus) fixed some typos.
|
||
- [Christian Deneke](https://github.com/chris0x44) added a const version of `json_pointer::back`.
|
||
- [Julien Hamaide](https://github.com/crazyjul) made the `items()` function work with custom string types.
|
||
- [Evan Nemerson](https://github.com/nemequ) updated fixed a bug in Hedley and updated this library accordingly.
|
||
- [Florian Pigorsch](https://github.com/flopp) fixed a lot of typos.
|
||
- [Camille Bégué](https://github.com/cbegue) fixed an issue in the conversion from `std::pair` and `std::tuple` to `json`.
|
||
- [Anthony VH](https://github.com/AnthonyVH) fixed a compile error in an enum deserialization.
|
||
|
||
Thanks a lot for helping out! Please [let me know](mailto:mail@nlohmann.me) if I forgot someone.
|
||
|
||
|
||
## Used third-party tools
|
||
|
||
The library itself consists of a single header file licensed under the MIT license. However, it is built, tested, documented, and whatnot using a lot of third-party tools and services. Thanks a lot!
|
||
|
||
- [**amalgamate.py - Amalgamate C source and header files**](https://github.com/edlund/amalgamate) to create a single header file
|
||
- [**American fuzzy lop**](http://lcamtuf.coredump.cx/afl/) for fuzz testing
|
||
- [**AppVeyor**](https://www.appveyor.com) for [continuous integration](https://ci.appveyor.com/project/nlohmann/json) on Windows
|
||
- [**Artistic Style**](http://astyle.sourceforge.net) for automatic source code indentation
|
||
- [**CircleCI**](http://circleci.com) for [continuous integration](https://circleci.com/gh/nlohmann/json).
|
||
- [**Clang**](https://clang.llvm.org) for compilation with code sanitizers
|
||
- [**CMake**](https://cmake.org) for build automation
|
||
- [**Codacity**](https://www.codacy.com) for further [code analysis](https://www.codacy.com/app/nlohmann/json)
|
||
- [**Coveralls**](https://coveralls.io) to measure [code coverage](https://coveralls.io/github/nlohmann/json)
|
||
- [**Coverity Scan**](https://scan.coverity.com) for [static analysis](https://scan.coverity.com/projects/nlohmann-json)
|
||
- [**cppcheck**](http://cppcheck.sourceforge.net) for static analysis
|
||
- [**doctest**](https://github.com/onqtam/doctest) for the unit tests
|
||
- [**Doxygen**](http://www.stack.nl/~dimitri/doxygen/) to generate [documentation](https://nlohmann.github.io/json/)
|
||
- [**git-update-ghpages**](https://github.com/rstacruz/git-update-ghpages) to upload the documentation to gh-pages
|
||
- [**GitHub Changelog Generator**](https://github.com/skywinder/github-changelog-generator) to generate the [ChangeLog](https://github.com/nlohmann/json/blob/develop/ChangeLog.md)
|
||
- [**Google Benchmark**](https://github.com/google/benchmark) to implement the benchmarks
|
||
- [**Hedley**](https://nemequ.github.io/hedley/) to avoid re-inventing several compiler-agnostic feature macros
|
||
- [**lcov**](http://ltp.sourceforge.net/coverage/lcov.php) to process coverage information and create a HTML view
|
||
- [**libFuzzer**](http://llvm.org/docs/LibFuzzer.html) to implement fuzz testing for OSS-Fuzz
|
||
- [**OSS-Fuzz**](https://github.com/google/oss-fuzz) for continuous fuzz testing of the library ([project repository](https://github.com/google/oss-fuzz/tree/master/projects/json))
|
||
- [**Probot**](https://probot.github.io) for automating maintainer tasks such as closing stale issues, requesting missing information, or detecting toxic comments.
|
||
- [**send_to_wandbox**](https://github.com/nlohmann/json/blob/develop/doc/scripts/send_to_wandbox.py) to send code examples to [Wandbox](http://melpon.org/wandbox)
|
||
- [**Travis**](https://travis-ci.org) for [continuous integration](https://travis-ci.org/nlohmann/json) on Linux and macOS
|
||
- [**Valgrind**](http://valgrind.org) to check for correct memory management
|
||
- [**Wandbox**](http://melpon.org/wandbox) for [online examples](https://wandbox.org/permlink/3lCHrFUZANONKv7a)
|
||
|
||
|
||
## Projects using JSON for Modern C++
|
||
|
||
The library is currently used in Apple macOS Sierra and iOS 10. I am not sure what they are using the library for, but I am happy that it runs on so many devices.
|
||
|
||
|
||
## Notes
|
||
|
||
### Character encoding
|
||
|
||
The library supports **Unicode input** as follows:
|
||
|
||
- Only **UTF-8** encoded input is supported which is the default encoding for JSON according to [RFC 8259](https://tools.ietf.org/html/rfc8259.html#section-8.1).
|
||
- `std::u16string` and `std::u32string` can be parsed, assuming UTF-16 and UTF-32 encoding, respectively. These encodings are not supported when reading from files or other input containers.
|
||
- Other encodings such as Latin-1 or ISO 8859-1 are **not** supported and will yield parse or serialization errors.
|
||
- [Unicode noncharacters](http://www.unicode.org/faq/private_use.html#nonchar1) will not be replaced by the library.
|
||
- Invalid surrogates (e.g., incomplete pairs such as `\uDEAD`) will yield parse errors.
|
||
- The strings stored in the library are UTF-8 encoded. When using the default string type (`std::string`), note that its length/size functions return the number of stored bytes rather than the number of characters or glyphs.
|
||
- When you store strings with different encodings in the library, calling [`dump()`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a50ec80b02d0f3f51130d4abb5d1cfdc5.html#a50ec80b02d0f3f51130d4abb5d1cfdc5) may throw an exception unless `json::error_handler_t::replace` or `json::error_handler_t::ignore` are used as error handlers.
|
||
|
||
### Comments in JSON
|
||
|
||
This library does not support comments. It does so for three reasons:
|
||
|
||
1. Comments are not part of the [JSON specification](https://tools.ietf.org/html/rfc8259). You may argue that `//` or `/* */` are allowed in JavaScript, but JSON is not JavaScript.
|
||
2. This was not an oversight: Douglas Crockford [wrote on this](https://plus.google.com/118095276221607585885/posts/RK8qyGVaGSr) in May 2012:
|
||
|
||
> I removed comments from JSON because I saw people were using them to hold parsing directives, a practice which would have destroyed interoperability. I know that the lack of comments makes some people sad, but it shouldn't.
|
||
|
||
> Suppose you are using JSON to keep configuration files, which you would like to annotate. Go ahead and insert all the comments you like. Then pipe it through JSMin before handing it to your JSON parser.
|
||
|
||
3. It is dangerous for interoperability if some libraries would add comment support while others don't. Please check [The Harmful Consequences of the Robustness Principle](https://tools.ietf.org/html/draft-iab-protocol-maintenance-01) on this.
|
||
|
||
This library will not support comments in the future. If you wish to use comments, I see three options:
|
||
|
||
1. Strip comments before using this library.
|
||
2. Use a different JSON library with comment support.
|
||
3. Use a format that natively supports comments (e.g., YAML or JSON5).
|
||
|
||
### Order of object keys
|
||
|
||
By default, the library does not preserve the **insertion order of object elements**. This is standards-compliant, as the [JSON standard](https://tools.ietf.org/html/rfc8259.html) defines objects as "an unordered collection of zero or more name/value pairs". If you do want to preserve the insertion order, you can specialize the object type with containers like [`tsl::ordered_map`](https://github.com/Tessil/ordered-map) ([integration](https://github.com/nlohmann/json/issues/546#issuecomment-304447518)) or [`nlohmann::fifo_map`](https://github.com/nlohmann/fifo_map) ([integration](https://github.com/nlohmann/json/issues/485#issuecomment-333652309)).
|
||
|
||
### Memory Release
|
||
|
||
We checked with Valgrind and the Address Sanitizer (ASAN) that there are no memory leaks.
|
||
|
||
If you find that a parsing program with this library does not release memory, please consider the following case and it maybe unrelated to this library.
|
||
|
||
**Your program is compiled with glibc.** There is a tunable threshold that glibc uses to decide whether to actually return memory to the system or whether to cache it for later reuse. If in your program you make lots of small allocations and those small allocations are not a contiguous block and are presumably below the threshold, then they will not get returned to the OS.
|
||
Here is a related issue [#1924](https://github.com/nlohmann/json/issues/1924).
|
||
|
||
### Further notes
|
||
|
||
- The code contains numerous debug **assertions** which can be switched off by defining the preprocessor macro `NDEBUG`, see the [documentation of `assert`](https://en.cppreference.com/w/cpp/error/assert). In particular, note [`operator[]`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a233b02b0839ef798942dd46157cc0fe6.html#a233b02b0839ef798942dd46157cc0fe6) implements **unchecked access** for const objects: If the given key is not present, the behavior is undefined (think of a dereferenced null pointer) and yields an [assertion failure](https://github.com/nlohmann/json/issues/289) if assertions are switched on. If you are not sure whether an element in an object exists, use checked access with the [`at()` function](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a73ae333487310e3302135189ce8ff5d8.html#a73ae333487310e3302135189ce8ff5d8).
|
||
- As the exact type of a number is not defined in the [JSON specification](https://tools.ietf.org/html/rfc8259.html), this library tries to choose the best fitting C++ number type automatically. As a result, the type `double` may be used to store numbers which may yield [**floating-point exceptions**](https://github.com/nlohmann/json/issues/181) in certain rare situations if floating-point exceptions have been unmasked in the calling code. These exceptions are not caused by the library and need to be fixed in the calling code, such as by re-masking the exceptions prior to calling library functions.
|
||
- The code can be compiled without C++ **runtime type identification** features; that is, you can use the `-fno-rtti` compiler flag.
|
||
- **Exceptions** are used widely within the library. They can, however, be switched off with either using the compiler flag `-fno-exceptions` or by defining the symbol `JSON_NOEXCEPTION`. In this case, exceptions are replaced by `abort()` calls. You can further control this behavior by defining `JSON_THROW_USER´` (overriding `throw`), `JSON_TRY_USER` (overriding `try`), and `JSON_CATCH_USER` (overriding `catch`). Note that `JSON_THROW_USER` should leave the current scope (e.g., by throwing or aborting), as continuing after it may yield undefined behavior.
|
||
|
||
## Execute unit tests
|
||
|
||
To compile and run the tests, you need to execute
|
||
|
||
```sh
|
||
$ mkdir build
|
||
$ cd build
|
||
$ cmake ..
|
||
$ cmake --build .
|
||
$ ctest --output-on-failure
|
||
```
|
||
|
||
For more information, have a look at the file [.travis.yml](https://github.com/nlohmann/json/blob/master/.travis.yml).
|