README.md 50.8 KB
Newer Older
Niels's avatar
Niels committed
1
[![JSON for Modern C++](https://raw.githubusercontent.com/nlohmann/json/master/doc/json.gif)](https://github.com/nlohmann/json/releases)
Niels's avatar
Niels committed
2

Niels's avatar
Niels committed
3
[![Build Status](https://travis-ci.org/nlohmann/json.svg?branch=master)](https://travis-ci.org/nlohmann/json)
4
[![Build Status](https://ci.appveyor.com/api/projects/status/1acb366xfyg3qybk/branch/develop?svg=true)](https://ci.appveyor.com/project/nlohmann/json)
Niels's avatar
Niels committed
5
[![Coverage Status](https://img.shields.io/coveralls/nlohmann/json.svg)](https://coveralls.io/r/nlohmann/json)
6
[![Coverity Scan Build Status](https://scan.coverity.com/projects/5550/badge.svg)](https://scan.coverity.com/projects/nlohmann-json)
7
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f3732b3327e34358a0e9d1fe9f661f08)](https://www.codacy.com/app/nlohmann/json?utm_source=github.com&utm_medium=referral&utm_content=nlohmann/json&utm_campaign=Badge_Grade)
Niels Lohmann's avatar
Niels Lohmann committed
8
[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/yCTCvQi0ZVxGuL3L)
Niels's avatar
Niels committed
9
[![Documentation](https://img.shields.io/badge/docs-doxygen-blue.svg)](http://nlohmann.github.io/json)
Niels's avatar
Niels committed
10
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nlohmann/json/master/LICENSE.MIT)
Niels's avatar
Niels committed
11
[![Github Releases](https://img.shields.io/github/release/nlohmann/json.svg)](https://github.com/nlohmann/json/releases)
Niels's avatar
Niels committed
12
[![Github Issues](https://img.shields.io/github/issues/nlohmann/json.svg)](http://github.com/nlohmann/json/issues)
13
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/nlohmann/json.svg)](http://isitmaintained.com/project/nlohmann/json "Average time to resolve an issue")
14
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/289/badge)](https://bestpractices.coreinfrastructure.org/projects/289)
Niels's avatar
Niels committed
15

16
17
18
19
20
21
22
23
24
- [Design goals](#design-goals)
- [Integration](#integration)
- [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)
  - [Implicit conversions](#implicit-conversions)
Niels Lohmann's avatar
Niels Lohmann committed
25
  - [Conversions to/from arbitrary types](#arbitrary-types-conversions)
26
27
28
  - [Binary formats (CBOR and MessagePack)](#binary-formats-cbor-and-messagepack)
- [Supported compilers](#supported-compilers)
- [License](#license)
29
- [Contact](#contact)
30
- [Thanks](#thanks)
31
- [Used third-party tools](#used-third-party-tools)
32
- [Projects using JSON for Modern C++](#projects-using-json-for-modern-c)
33
34
35
- [Notes](#notes)
- [Execute unit tests](#execute-unit-tests)

Niels's avatar
Niels committed
36
37
38
39
## Design goals

There are myriads of [JSON](http://json.org) libraries out there, and each may even have its reason to exist. Our class had these design goals:

40
- **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.
Niels's avatar
Niels committed
41

Niels's avatar
Niels committed
42
- **Trivial integration**. Our whole code consists of a single header file [`json.hpp`](https://github.com/nlohmann/json/blob/develop/src/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.
Niels's avatar
Niels committed
43

Niels's avatar
Niels committed
44
- **Serious testing**. Our class is heavily [unit-tested](https://github.com/nlohmann/json/blob/master/test/src/unit.cpp) and covers [100%](https://coveralls.io/r/nlohmann/json) of the code, including all exceptional behavior. Furthermore, we checked with [Valgrind](http://valgrind.org) that there are no memory leaks. To maintain high quality, the project is following the [Core Infrastructure Initiative (CII) best practices](https://bestpractices.coreinfrastructure.org/projects/289).
Niels's avatar
Niels committed
45
46
47

Other aspects were not so important to us:

Niels's avatar
Niels committed
48
- **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.
Niels's avatar
Niels committed
49

Niels Lohmann's avatar
Niels Lohmann committed
50
- **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.
Niels's avatar
Niels committed
51

Niels's avatar
cleanup    
Niels committed
52
See the [contribution guidelines](https://github.com/nlohmann/json/blob/master/.github/CONTRIBUTING.md#please-dont) for more information.
Niels's avatar
Niels committed
53

Niels's avatar
Niels committed
54

Niels's avatar
Niels committed
55
56
## Integration

Niels's avatar
Niels committed
57
The single required source, file `json.hpp` is in the `src` directory or [released here](https://github.com/nlohmann/json/releases). All you need to do is add
Niels's avatar
Niels committed
58
59
60
61
62
63
64
65
66
67

```cpp
#include "json.hpp"

// for convenience
using json = nlohmann::json;
```

to the files you want to use JSON objects. That's it. Do not forget to set the necessary switches to enable C++11 (e.g., `-std=c++11` for GCC and Clang).

68
: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`.
Niels's avatar
Niels committed
69

70
If you are using the [Meson Build System](http://mesonbuild.com), then you can wrap this repo as a subproject.
Jay Sistar's avatar
Jay Sistar committed
71

72
73
If you are using [Conan](https://www.conan.io/) to manage your dependencies, merely add `jsonformoderncpp/x.y.z@vthiery/stable` to your `conanfile.py`'s requires, where `x.y.z` is the release version you want to use. Please file issues [here](https://github.com/vthiery/conan-jsonformoderncpp/issues) if you experience problems with the packages.

Jorrit Wronski's avatar
Jorrit Wronski committed
74
If you are using [hunter](https://github.com/ruslo/hunter/) on your project for external dependencies, then you can use the [nlohmann_json package](https://docs.hunter.sh/en/latest/packages/pkg/nlohmann_json.html). Please see the hunter project for any issues regarding the packaging.
gregmarr's avatar
gregmarr committed
75
76

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.
77

78
79
:warning: [Version 3.0.0](https://github.com/nlohmann/json/wiki/Road-toward-3.0.0) is currently under development. Branch `develop` is used for the ongoing work and is probably **unstable**. Please use the `master` branch for the last stable version 2.1.1.

80

Niels's avatar
Niels committed
81
82
## Examples

83
84
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_a602f275f0359ab181221384989810604.html#a602f275f0359ab181221384989810604)). 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)).

85
86
### JSON as first-class data type

Niels's avatar
Niels committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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 the JSON class, 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}
  }}
};
```

AQNOUCH Mohammed's avatar
AQNOUCH Mohammed committed
152
Note that in all these cases, you never need to "tell" the compiler which JSON value you want to use. If you want to be explicit or express some edge cases, the functions `json::array` and `json::object` will help:
Niels's avatar
Niels committed
153
154

```cpp
Niels's avatar
Niels committed
155
// a way to express the empty array []
Niels's avatar
Niels committed
156
157
json empty_array_explicit = json::array();

Niels's avatar
Niels committed
158
159
// ways to express the empty object {}
json empty_object_implicit = json({});
Niels's avatar
Niels committed
160
161
162
json empty_object_explicit = json::object();

// a way to express an _array_ of key/value pairs [["currency", "USD"], ["value", 42.99]]
163
json array_not_object = json::array({ {"currency", "USD"}, {"value", 42.99} });
Niels's avatar
Niels committed
164
165
```

Niels's avatar
Niels committed
166

Niels's avatar
Niels committed
167
168
### Serialization / Deserialization

Niels Lohmann's avatar
Niels Lohmann committed
169
170
#### To/from strings

Niels's avatar
Niels committed
171
172
173
174
175
176
You can create an object (deserialization) by appending `_json` to a string literal:

```cpp
// create object from string literal
json j = "{ \"happy\": true, \"pi\": 3.141 }"_json;

Niels's avatar
Niels committed
177
// or even nicer with a raw string literal
Niels's avatar
Niels committed
178
179
180
181
182
183
auto j2 = R"(
  {
    "happy": true,
    "pi": 3.141
  }
)"_json;
184
185
```

Niels Lohmann's avatar
Niels Lohmann committed
186
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.
Niels's avatar
Niels committed
187

188
189
190
191
The above example can also be expressed explicitly using `json::parse()`:

```cpp
// parse explicitly
Niels's avatar
Niels committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
auto j3 = json::parse("{ \"happy\": true, \"pi\": 3.141 }");
```

You can also get a string representation (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
// }
```

210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
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 (implicit JSON to std::string conversion)
std::string cpp_string = j_string;
// retrieve the string value (explicit JSON to std::string conversion)
auto cpp_string2 = j_string.get<std::string>();

// 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()` always returns the serialized value, and `.get<std::string>()` returns the originally stored string value.


Niels Lohmann's avatar
Niels Lohmann committed
233
234
#### To/from streams (e.g. files, string streams)

Niels's avatar
Niels committed
235
236
237
238
239
You can also use streams to serialize and deserialize:

```cpp
// deserialize from standard input
json j;
Niels's avatar
Niels committed
240
std::cin >> j;
Niels's avatar
Niels committed
241
242
243
244
245
246
247
248

// 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;
```

Niels Lohmann's avatar
Niels Lohmann committed
249
250
251
252
253
254
255
256
257
258
259
260
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;
```
Niels's avatar
Niels committed
261

Kevin Dixon's avatar
Kevin Dixon committed
262
263
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.

Niels Lohmann's avatar
Niels Lohmann committed
264
265
#### Read from iterator range

266
You can also read 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>`:
Niels Lohmann's avatar
Niels Lohmann committed
267
268

```cpp
269
std::vector<std::uint8_t> v = {'t', 'r', 'u', 'e'};
Niels Lohmann's avatar
Niels Lohmann committed
270
271
272
273
274
275
json j = json::parse(v.begin(), v.end());
```

You may leave the iterators for the range [begin, end):

```cpp
276
std::vector<std::uint8_t> v = {'t', 'r', 'u', 'e'};
Niels Lohmann's avatar
Niels Lohmann committed
277
278
279
json j = json::parse(v);
```

Niels's avatar
Niels committed
280

Niels's avatar
Niels committed
281
282
### STL-like access

Niels's avatar
Niels committed
283
We designed the JSON class to behave just like an STL container. In fact, it satisfies the [**ReversibleContainer**](http://en.cppreference.com/w/cpp/concept/ReversibleContainer) requirement.
Niels's avatar
Niels committed
284
285
286
287
288
289
290
291

```cpp
// create an array using push_back
json j;
j.push_back("foo");
j.push_back(1);
j.push_back(true);

Niels Lohmann's avatar
Niels Lohmann committed
292
293
294
// also use emplace_back
j.emplace_back(1.78);

Niels's avatar
Niels committed
295
296
297
298
299
300
// iterate the array
for (json::iterator it = j.begin(); it != j.end(); ++it) {
  std::cout << *it << '\n';
}

// range-based for
Niels's avatar
Niels committed
301
for (auto& element : j) {
Niels's avatar
Niels committed
302
303
304
305
306
307
308
309
  std::cout << element << '\n';
}

// getter/setter
const std::string tmp = j[0];
j[1] = 42;
bool foo = j.at(2);

Jonathan Lee's avatar
Jonathan Lee committed
310
311
312
// comparison
j == "[\"foo\", 1, true]"_json;  // true

Niels's avatar
Niels committed
313
314
315
316
317
318
// other stuff
j.size();     // 3 entries
j.empty();    // false
j.type();     // json::value_t::array
j.clear();    // the array is empty again

Niels's avatar
Niels committed
319
320
321
322
323
324
325
326
// convenience type checkers
j.is_null();
j.is_boolean();
j.is_number();
j.is_object();
j.is_array();
j.is_string();

Niels's avatar
Niels committed
327
328
329
330
331
332
// create an object
json o;
o["foo"] = 23;
o["bar"] = false;
o["baz"] = 3.141;

Niels Lohmann's avatar
Niels Lohmann committed
333
334
335
// also use emplace
o.emplace("weather", "sunny");

Niels's avatar
Niels committed
336
337
338
339
340
// special iterator member functions for objects
for (json::iterator it = o.begin(); it != o.end(); ++it) {
  std::cout << it.key() << " : " << it.value() << "\n";
}

Niels's avatar
Niels committed
341
342
343
344
// find an entry
if (o.find("foo") != o.end()) {
  // there is an entry with key "foo"
}
Niels's avatar
Niels committed
345
346
347
348
349
350
351

// or simpler using count()
int foo_present = o.count("foo"); // 1
int fob_present = o.count("fob"); // 0

// delete an entry
o.erase("foo");
Niels's avatar
Niels committed
352
353
```

Niels's avatar
Niels committed
354

Niels's avatar
Niels committed
355
356
### Conversion from STL containers

Itja's avatar
Itja committed
357
Any sequence container (`std::array`, `std::vector`, `std::deque`, `std::forward_list`, `std::list`) whose values can be used to construct JSON types (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.
Niels's avatar
Niels committed
358
359
360
361
362
363

```cpp
std::vector<int> c_vector {1, 2, 3, 4};
json j_vec(c_vector);
// [1, 2, 3, 4]

Niels's avatar
Niels committed
364
std::deque<double> c_deque {1.2, 2.3, 3.4, 5.6};
Niels's avatar
Niels committed
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
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"};
389
390
json j_mset(c_mset); // both entries for "one" are used
// maybe ["one", "two", "one", "four"]
Niels's avatar
Niels committed
391
392
393
394
395
396

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"]
```

Markus Werle's avatar
Markus Werle committed
397
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 types (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.
Niels's avatar
Niels committed
398
399
400
401

```cpp
std::map<std::string, int> c_map { {"one", 1}, {"two", 2}, {"three", 3} };
json j_map(c_map);
Annihil's avatar
Annihil committed
402
// {"one": 1, "three": 3, "two": 2 }
Niels's avatar
Niels committed
403

Niels's avatar
Niels committed
404
std::unordered_map<const char*, double> c_umap { {"one", 1.2}, {"two", 2.3}, {"three", 3.4} };
Niels's avatar
Niels committed
405
406
407
408
409
410
411
412
413
414
415
416
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}
```

Niels's avatar
Niels committed
417
418
419
420
421
422
423
424
425
426
427
428
### 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)
Niels's avatar
Niels committed
429
j_original["/baz/1"_json_pointer];
Niels's avatar
Niels committed
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
// "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"] },
Niels's avatar
Niels committed
450
451
//   { "op": "remove","path": "/hello" },
//   { "op": "add", "path": "/foo", "value": "bar" }
Niels's avatar
Niels committed
452
453
454
455
// ]
```


Niels's avatar
Niels committed
456
457
458
459
460
### Implicit conversions

The type of the JSON object is determined automatically by the expression to store. Likewise, the stored value is implicitly converted.

```cpp
Niels's avatar
Niels committed
461
// strings
Niels's avatar
Niels committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
std::string s1 = "Hello, world!";
json js = s1;
std::string s2 = js;

// Booleans
bool b1 = true;
json jb = b1;
bool b2 = jb;

// numbers
int i = 42;
json jn = i;
double f = jn;

// etc.
```

You can also explicitly ask for the value:

```cpp
std::string vs = js.get<std::string>();
bool vb = jb.get<bool>();
int vi = jn.get<int>();

// etc.
```
Niels Lohmann's avatar
Niels Lohmann committed
488

Théo DELRIEU's avatar
Théo DELRIEU committed
489
490
### Arbitrary types conversions

Niels Lohmann's avatar
Niels Lohmann committed
491
Every type can be serialized in JSON, not just STL-containers and scalar types. Usually, you would do something along those lines:
Théo DELRIEU's avatar
Théo DELRIEU committed
492
493
494

```cpp
namespace ns {
Niels Lohmann's avatar
Niels Lohmann committed
495
    // a simple struct to model a person
Niels Lohmann's avatar
Niels Lohmann committed
496
497
498
499
500
    struct person {
        std::string name;
        std::string address;
        int age;
    };
Théo DELRIEU's avatar
Théo DELRIEU committed
501
}
Niels Lohmann's avatar
Niels Lohmann committed
502

Niels Lohmann's avatar
Niels Lohmann committed
503
504
ns::person p = {"Ned Flanders", "744 Evergreen Terrace", 60};

Niels Lohmann's avatar
Niels Lohmann committed
505
// convert to JSON: copy each value into the JSON object
Théo DELRIEU's avatar
Théo DELRIEU committed
506
507
508
509
510
511
512
json j;
j["name"] = p.name;
j["address"] = p.address;
j["age"] = p.age;

// ...

Niels Lohmann's avatar
Niels Lohmann committed
513
// convert from JSON: copy each value from the JSON object
Niels Lohmann's avatar
Niels Lohmann committed
514
515
516
517
518
ns::person p {
    j["name"].get<std::string>(),
    j["address"].get<std::string>(),
    j["age"].get<int>()
};
Théo DELRIEU's avatar
Théo DELRIEU committed
519
520
```

Niels Lohmann's avatar
Niels Lohmann committed
521
It works, but that's quite a lot of boilerplate... Fortunately, there's a better way:
Théo DELRIEU's avatar
Théo DELRIEU committed
522
523

```cpp
Niels Lohmann's avatar
Niels Lohmann committed
524
525
526
527
// create a person
ns::person p {"Ned Flanders", "744 Evergreen Terrace", 60};

// conversion: person -> json
Théo DELRIEU's avatar
Théo DELRIEU committed
528
529
json j = p;

Niels Lohmann's avatar
Niels Lohmann committed
530
531
532
533
534
535
536
std::cout << j << std::endl;
// {"address":"744 Evergreen Terrace","age":60,"name":"Ned Flanders"}

// conversion: json -> person
ns::person p2 = j;

// that's it
Théo DELRIEU's avatar
Théo DELRIEU committed
537
538
539
540
541
assert(p == p2);
```

#### Basic usage

Niels Lohmann's avatar
Niels Lohmann committed
542
To make this work with one of your types, you only need to provide two functions:
Théo DELRIEU's avatar
Théo DELRIEU committed
543
544
545
546
547

```cpp
using nlohmann::json;

namespace ns {
Niels Lohmann's avatar
Niels Lohmann committed
548
    void to_json(json& j, const person& p) {
Niels Lohmann's avatar
Niels Lohmann committed
549
550
551
        j = json{{"name", p.name}, {"address", p.address}, {"age", p.age}};
    }

Niels Lohmann's avatar
Niels Lohmann committed
552
    void from_json(const json& j, person& p) {
553
554
555
        p.name = j.at("name").get<std::string>();
        p.address = j.at("address").get<std::string>();
        p.age = j.at("age").get<int>();
Niels Lohmann's avatar
Niels Lohmann committed
556
    }
Théo DELRIEU's avatar
Théo DELRIEU committed
557
558
559
} // namespace ns
```

Niels Lohmann's avatar
Niels Lohmann committed
560
That's all! When calling the `json` constructor with your type, your custom `to_json` method will be automatically called.
Théo DELRIEU's avatar
Théo DELRIEU committed
561
562
563
564
Likewise, when calling `get<your_type>()`, the `from_json` method will be called.

Some important things:

Niels Lohmann's avatar
Niels Lohmann committed
565
* 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).
Niels Lohmann's avatar
Niels Lohmann committed
566
* When using `get<your_type>()`, `your_type` **MUST** be [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible). (There is a way to bypass this requirement described later.)
Itja's avatar
Itja committed
567
* 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.
Niels Lohmann's avatar
Niels Lohmann committed
568
569
* In case your type contains several `operator=` definitions, code like `your_variable = your_json;` [may not compile](https://github.com/nlohmann/json/issues/667). You need to write `your_variable = your_json.get<decltype your_variable>();` instead.
* You do not need to add serializers or deserializers for STL types like `std::vector`: the library already implements these.
Niels Lohmann's avatar
Niels Lohmann committed
570
* Be careful with the definition order of the `from_json`/`to_json` functions: If a type `B` has a member of type `A`, you **MUST** define `to_json(A)` before `to_json(B)`. Look at [issue 561](https://github.com/nlohmann/json/issues/561) for more details.
Niels Lohmann's avatar
Niels Lohmann committed
571

Théo DELRIEU's avatar
Théo DELRIEU committed
572
573
574

#### How do I convert third-party types?

Niels Lohmann's avatar
Niels Lohmann committed
575
This requires a bit more advanced technique. But first, let's see how this conversion mechanism works:
Théo DELRIEU's avatar
Théo DELRIEU committed
576
577

The library uses **JSON Serializers** to convert types to json.
Niels Lohmann's avatar
Niels Lohmann committed
578
The default serializer for `nlohmann::json` is `nlohmann::adl_serializer` (ADL means [Argument-Dependent Lookup](http://en.cppreference.com/w/cpp/language/adl)).
Théo DELRIEU's avatar
Théo DELRIEU committed
579
580
581
582
583

It is implemented like this (simplified):

```cpp
template <typename T>
Niels Lohmann's avatar
Niels Lohmann committed
584
585
586
587
588
589
590
591
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
    }
Théo DELRIEU's avatar
Théo DELRIEU committed
592
593
594
};
```

Niels Lohmann's avatar
Niels Lohmann committed
595
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`...
Théo DELRIEU's avatar
Théo DELRIEU committed
596
597
598
599
600
601

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 {
Niels Lohmann's avatar
Niels Lohmann committed
602
603
604
605
606
607
    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 {
Niels Lohmann's avatar
Niels Lohmann committed
608
609
              j = *opt; // this will call adl_serializer<T>::to_json which will
                        // find the free function to_json in T's namespace!
Niels Lohmann's avatar
Niels Lohmann committed
610
611
612
613
            }
        }

        static void from_json(const json& j, boost::optional<T>& opt) {
614
615
616
            if (j.is_null()) {
                opt = boost::none;
            } else {
Niels Lohmann's avatar
Niels Lohmann committed
617
618
619
620
621
                opt = j.get<T>(); // same as above, but with 
                                  // adl_serializer<T>::from_json
            }
        }
    };
Théo DELRIEU's avatar
Théo DELRIEU committed
622
623
624
625
626
}
```

#### How can I use `get()` for non-default constructible/non-copyable types?

Niels Lohmann's avatar
Niels Lohmann committed
627
There is a way, if your type is [MoveConstructible](http://en.cppreference.com/w/cpp/concept/MoveConstructible). You will need to specialize the `adl_serializer` as well, but with a special `from_json` overload:
Théo DELRIEU's avatar
Théo DELRIEU committed
628
629
630

```cpp
struct move_only_type {
Niels Lohmann's avatar
Niels Lohmann committed
631
632
633
634
635
    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;
    
Niels Lohmann's avatar
Niels Lohmann committed
636
    int i;
Théo DELRIEU's avatar
Théo DELRIEU committed
637
638
639
};

namespace nlohmann {
Niels Lohmann's avatar
Niels Lohmann committed
640
641
    template <>
    struct adl_serializer<move_only_type> {
Niels Lohmann's avatar
Niels Lohmann committed
642
643
        // note: the return type is no longer 'void', and the method only takes
        // one argument
Niels Lohmann's avatar
Niels Lohmann committed
644
645
646
647
        static move_only_type from_json(const json& j) {
            return {j.get<int>()};
        }
        
Niels Lohmann's avatar
Niels Lohmann committed
648
649
650
        // 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
Niels Lohmann's avatar
Niels Lohmann committed
651
652
653
654
        static void to_json(json& j, move_only_type t) {
            j = t.i;
        }
    };
Théo DELRIEU's avatar
Théo DELRIEU committed
655
656
657
658
659
}
```

#### Can I write my own serializer? (Advanced use)

Niels Lohmann's avatar
Niels Lohmann committed
660
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.
Théo DELRIEU's avatar
Théo DELRIEU committed
661
662
663

If you write your own serializer, you'll need to do a few things:

Niels Lohmann's avatar
Niels Lohmann committed
664
* use a different `basic_json` alias than `nlohmann::json` (the last template parameter of `basic_json` is the `JSONSerializer`)
Théo DELRIEU's avatar
Théo DELRIEU committed
665
666
667
668
669
670
* 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
Niels Lohmann's avatar
Niels Lohmann committed
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
// 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);
    }
Théo DELRIEU's avatar
Théo DELRIEU committed
689
690
691
692
693
694
695
696
697
};
```

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
{
Niels Lohmann's avatar
Niels Lohmann committed
698
699
700
701
702
703
704
705
706
707
708
709
710
    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!
    }
Théo DELRIEU's avatar
Théo DELRIEU committed
711
712
};
```
Niels's avatar
Niels committed
713

714
715
716
717
718
719
720
721
722
### Binary formats (CBOR and MessagePack)

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 [CBOR](http://cbor.io) (Concise Binary Object Representation) and [MessagePack](http://msgpack.org) 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 CBOR
723
std::vector<std::uint8_t> v_cbor = json::to_cbor(j);
724
725
726
727
728
729
730

// 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
731
std::vector<std::uint8_t> v_msgpack = json::to_msgpack(j);
732
733
734
735
736
737
738

// 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);
```

Niels's avatar
Niels committed
739
740
741
742
743

## Supported compilers

Though it's 2016 already, the support for C++11 is still a bit sparse. Currently, the following compilers are known to work:

Niels Lohmann's avatar
Niels Lohmann committed
744
- GCC 4.9 - 7.2 (and possibly later)
745
- Clang 3.4 - 5.0 (and possibly later)
746
- Intel C++ Compiler 17.0.2 (and possibly later)
Niels's avatar
Niels committed
747
- Microsoft Visual C++ 2015 / Build Tools 14.0.25123.0 (and possibly later)
Niels Lohmann's avatar
Niels Lohmann committed
748
- Microsoft Visual C++ 2017 / Build Tools 15.5.180.51428 (and possibly later)
Niels's avatar
Niels committed
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770

I would be happy to learn about other compilers/versions.

Please note:

- GCC 4.8 does not work because of two bugs ([55817](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=55817) and [57824](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=57824)) in the C++11 support. Note there is a [pull request](https://github.com/nlohmann/json/pull/212) to fix some of the issues.
- 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`) 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).

The following compilers are currently used in continuous integration at [Travis](https://travis-ci.org/nlohmann/json) and [AppVeyor](https://ci.appveyor.com/project/nlohmann/json):

| Compiler        | Operating System             | Version String |
|-----------------|------------------------------|----------------|
Niels Lohmann's avatar
Niels Lohmann committed
771
772
773
| GCC 4.9.4       | Ubuntu 14.04.5 LTS           | g++-4.9 (Ubuntu 4.9.4-2ubuntu1~14.04.1) 4.9.4 |
| GCC 5.4.1       | Ubuntu 14.04.5 LTS           | g++-5 (Ubuntu 5.4.1-2ubuntu1~14.04) 5.4.1 20160904 |
| GCC 6.3.0       | Ubuntu 14.04.5 LTS           | g++-6 (Ubuntu/Linaro 6.3.0-18ubuntu2~14.04) 6.3.0 20170519 |
774
| GCC 7.1.0       | Ubuntu 14.04.5 LTS           | g++-7 (Ubuntu 7.1.0-5ubuntu2~14.04) 7.1.0
Niels Lohmann's avatar
Niels Lohmann committed
775
776
777
778
779
780
| Clang 3.5.0     | Ubuntu 14.04.5 LTS           | clang version 3.5.0-4ubuntu2~trusty2 (tags/RELEASE_350/final) |
| Clang 3.6.2     | Ubuntu 14.04.5 LTS           | clang version 3.6.2-svn240577-1~exp1 (branches/release_36) |
| Clang 3.7.1     | Ubuntu 14.04.5 LTS           | clang version 3.7.1-svn253571-1~exp1 (branches/release_37) |
| Clang 3.8.0     | Ubuntu 14.04.5 LTS           | clang version 3.8.0-2ubuntu3~trusty5 (tags/RELEASE_380/final) |
| Clang 3.9.1     | Ubuntu 14.04.5 LTS           | clang version 3.9.1-4ubuntu3~14.04.2 (tags/RELEASE_391/rc2) |
| Clang 4.0.1     | Ubuntu 14.04.5 LTS           | clang version 4.0.1-svn305264-1~exp1 (branches/release_40) |
781
| Clang 5.0.0     | Ubuntu 14.04.5 LTS           | clang version 5.0.0-svn310902-1~exp1 (branches/release_50) |
Niels's avatar
Niels committed
782
783
| Clang Xcode 6.4 | Darwin Kernel Version 14.3.0 (OSX 10.10.3) | Apple LLVM version 6.1.0 (clang-602.0.53) (based on LLVM 3.6.0svn) |
| Clang Xcode 7.3 | Darwin Kernel Version 15.0.0 (OSX 10.10.5) | Apple LLVM version 7.3.0 (clang-703.0.29) |
784
| Clang Xcode 8.0 | Darwin Kernel Version 15.6.0 | Apple LLVM version 8.0.0 (clang-800.0.38) |
785
| Clang Xcode 8.1 | Darwin Kernel Version 16.1.0 (macOS 10.12.1) | Apple LLVM version 8.0.0 (clang-800.0.42.1) |
786
| Clang Xcode 8.2 | Darwin Kernel Version 16.1.0 (macOS 10.12.1) | Apple LLVM version 8.0.0 (clang-800.0.42.1) |
Niels Lohmann's avatar
Niels Lohmann committed
787
| Clang Xcode 8.3 | Darwin Kernel Version 16.5.0 (macOS 10.12.4) | Apple LLVM version 8.1.0 (clang-802.0.38) |
Niels Lohmann's avatar
Niels Lohmann committed
788
789
790
791
792
| Clang Xcode 9.0 | Darwin Kernel Version 16.7.0 (macOS 10.12.6) | Apple LLVM version 9.0.0 (clang-900.0.37) |
| Clang Xcode 9.1 | Darwin Kernel Version 16.7.0 (macOS 10.12.6) | Apple LLVM version 9.0.0 (clang-900.0.38) |
| Clang Xcode 9.2 | Darwin Kernel Version 16.7.0 (macOS 10.12.6) | Apple LLVM version 8.1.0 (clang-900.0.39.2) |
| Visual Studio 14 2015 | Windows Server 2012 R2 (x64) | Microsoft (R) Build Engine version 14.0.25420.1, MSVC 19.0.24215.1 | 
| Visual Studio 2017 | Windows Server 2016 | Microsoft (R) Build Engine version 15.5.180.51428, MSVC 19.12.25830.2 |
Niels's avatar
Niels committed
793

Niels's avatar
Niels committed
794
795
796
797
798
799
## 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):

Niels Lohmann's avatar
Niels Lohmann committed
800
Copyright &copy; 2013-2017 [Niels Lohmann](http://nlohmann.me)
Niels's avatar
Niels committed
801

Niels's avatar
Niels committed
802
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:
Niels's avatar
Niels committed
803
804
805

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Niels's avatar
Niels committed
806
807
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.

808
809
* * *

Niels Lohmann's avatar
Niels Lohmann committed
810
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 &copy; 2008-2009 [Björn Hoehrmann](http://bjoern.hoehrmann.de/) <bjoern@hoehrmann.de>
Niels's avatar
Niels committed
811

812
813
814
815
## 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). 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.

Niels Lohmann's avatar
Niels Lohmann committed
816
Only if your request would contain confidential information, please [send me an email](mailto:mail@nlohmann.me). For encrypted messages, please usse [this key](https://keybase.io/nlohmann/pgp_keys.asc).
817
818


Niels's avatar
Niels committed
819
820
821
822
823
824
825
826
827
## Thanks

I deeply appreciate the help of the following people.

- [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.
Niels's avatar
Niels committed
828
- [Joshua C. Randall](https://github.com/jrandall) fixed a bug in the floating-point serialization.
Niels's avatar
Niels committed
829
- [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.
Niels's avatar
Niels committed
830
- [Daniel Kopeček](https://github.com/dkopecek) fixed a bug in the compilation with GCC 5.0.
Niels's avatar
Niels committed
831
- [Florian Weber](https://github.com/Florianjw) fixed a bug in and improved the performance of the comparison operators.
Niels's avatar
Niels committed
832
- [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.
Niels's avatar
Niels committed
833
- [易思龙](https://github.com/likebeta) implemented a conversion from anonymous enums.
Niels's avatar
Niels committed
834
- [kepkin](https://github.com/kepkin) patiently pushed forward the support for Microsoft Visual studio.
Niels Lohmann's avatar
Niels Lohmann committed
835
- [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.
Niels's avatar
Niels committed
836
- [Caio Luppi](https://github.com/caiovlp) fixed a bug in the Unicode handling.
Niels's avatar
Cleanup    
Niels committed
837
838
839
840
841
- [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.
Niels's avatar
Niels committed
842
- [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.
Niels's avatar
Niels committed
843
- [ZahlGraf](https://github.com/ZahlGraf) added a workaround that allows compilation using Android NDK.
Niels's avatar
Niels committed
844
- [whackashoe](https://github.com/whackashoe) replaced a function that was marked as unsafe by Visual Studio.
Niels's avatar
Niels committed
845
- [406345](https://github.com/406345) fixed two small warnings.
Niels's avatar
Niels committed
846
- [Glen Fernandes](https://github.com/glenfe) noted a potential portability problem in the `has_mapped_type` function.
Niels's avatar
thanks    
Niels committed
847
- [Corbin Hughes](https://github.com/nibroc) fixed some typos in the contribution guidelines.
Niels's avatar
Niels committed
848
- [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.
Niels's avatar
thanks    
Niels committed
849
- [Volker Diels-Grabsch](https://github.com/vog) fixed a link in the README file.
Niels's avatar
Niels committed
850
- [msm-](https://github.com/msm-) added support for american fuzzy lop. 
Niels's avatar
Niels committed
851
852
- [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.
Niels's avatar
Niels committed
853
854
- [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).
Niels's avatar
Niels committed
855
- [zewt](https://github.com/zewt) added useful notes to the README file about Android.
Niels's avatar
thanks    
Niels committed
856
857
- [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.
Niels's avatar
Niels committed
858
- [Tom Needham](https://github.com/06needhamt) fixed a subtle bug with MSVC 2015 which was also proposed by [Michael K.](https://github.com/Epidal).
Niels's avatar
Niels committed
859
- [Mário Feroldi](https://github.com/thelostt) fixed a small typo.
Niels's avatar
Niels committed
860
- [duncanwerner](https://github.com/duncanwerner) found a really embarrassing performance regression in the 2.0.0 release.
Niels's avatar
Niels committed
861
- [Damien](https://github.com/dtoma) fixed one of the last conversion warnings.
Niels's avatar
cleanup    
Niels committed
862
- [Thomas Braun](https://github.com/t-b) fixed a warning in a test case.
Niels Lohmann's avatar
Niels Lohmann committed
863
- [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.
Niels's avatar
Niels committed
864
- [Stefan](https://github.com/5tefan) fixed a minor issue in the documentation.
Niels's avatar
Niels committed
865
866
- [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.
Niels Lohmann's avatar
Niels Lohmann committed
867
- [Vladimir Petrigo](https://github.com/vpetrigo) made a SFINAE hack more readable and added Visual Studio 17 to the build matrix.
Niels's avatar
Niels committed
868
- [Denis Andrejew](https://github.com/seeekr) fixed a grammar issue in the README file.
869
- [Pierre-Antoine Lacaze](https://github.com/palacaze) found a subtle bug in the `dump()` function.
Niels Lohmann's avatar
Niels Lohmann committed
870
- [TurpentineDistillery](https://github.com/TurpentineDistillery) pointed to [`std::locale::classic()`](http://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.
871
- [cgzones](https://github.com/cgzones) had an idea how to fix the Coverity scan.
Niels Lohmann's avatar
Niels Lohmann committed
872
- [Jared Grubb](https://github.com/jaredgrubb) silenced a nasty documentation warning.
873
- [Yixin Zhang](https://github.com/qwename) fixed an integer overflow check.
Niels Lohmann's avatar
Niels Lohmann committed
874
- [Bosswestfalen](https://github.com/Bosswestfalen) merged two iterator classes into a smaller one.
Niels Lohmann's avatar
Niels Lohmann committed
875
- [Daniel599](https://github.com/Daniel599) helped to get Travis execute the tests with Clang's sanitizers.
876
- [Jonathan Lee](https://github.com/vjon) fixed an example in the README file.
Niels Lohmann's avatar
Niels Lohmann committed
877
878
879
- [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.
Niels Lohmann's avatar
Niels Lohmann committed
880
- [EnricoBilla](https://github.com/EnricoBilla) noted a typo in an example.
881
882
- [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.
Niels Lohmann's avatar
Niels Lohmann committed
883
- [rswanson-ihi](https://github.com/rswanson-ihi) noted a typo in the README.
884
- [Mihai Stan](https://github.com/stanmihai4) fixed a bug in the comparison with `nullptr`s.
885
- [Tushar Maheshwari](https://github.com/tusharpm) added [cotire](https://github.com/sakra/cotire) support to speed up the compilation.
Niels Lohmann's avatar
Niels Lohmann committed
886
- [TedLyngmo](https://github.com/TedLyngmo) noted a typo in the README, removed unnecessary bit arithmetic, and fixed some `-Weffc++` warnings.
887
888
- [Krzysztof Woś](https://github.com/krzysztofwos) made exceptions more visible.
- [ftillier](https://github.com/ftillier) fixed a compiler warning.
889
- [tinloaf](https://github.com/tinloaf) made sure all pushed warnings are properly popped.
890
- [Fytch](https://github.com/Fytch) found a bug in the documentation.
Niels Lohmann's avatar
Niels Lohmann committed
891
892
- [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.
893
- [Vincent Thiery](https://github.com/vthiery) maintains a package for the Conan package manager.
Niels Lohmann's avatar
Niels Lohmann committed
894
- [Steffen](https://github.com/koemeet) fixed a potential issue with MSVC and `std::min`.
895
- [Mike Tzou](https://github.com/Chocobo1) fixed some typos.
Niels Lohmann's avatar
Niels Lohmann committed
896
- [amrcode](https://github.com/amrcode) noted a missleading documentation about comparison of floats.
Niels Lohmann's avatar
Niels Lohmann committed
897
898
899
- [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.
900
901
902
903
904
- [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.
905
906
- [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.
907
908
909
910
911
912
- [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.
Niels Lohmann's avatar
Niels Lohmann committed
913
- [Jamie Seward](https://github.com/jseward) avoided unneccessary string copies in `find()` and `count()`.
Niels Lohmann's avatar
Niels Lohmann committed
914
- [Mitja](https://github.com/Itja) fixed some typos.
Niels Lohmann's avatar
Niels Lohmann committed
915
916
917
- [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.
Niels Lohmann's avatar
Niels Lohmann committed
918

Niels's avatar
Niels committed
919

920
Thanks a lot for helping out! Please [let me know](mailto:mail@nlohmann.me) if I forgot someone.
Niels's avatar
Niels committed
921

Niels's avatar
Niels committed
922

923
924
## Used third-party tools

Niels Lohmann's avatar
Niels Lohmann committed
925
The library itself contains 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!
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943

- [**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 identation
- [**benchpress**](https://github.com/sbs-ableton/benchpress) to benchmark the code
- [**Catch**](https://github.com/philsquared/Catch) for the unit tests
- [**Clang**](http://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
- [**cxxopts**](https://github.com/jarro2783/cxxopts) to let benchpress parse command-line parameters
- [**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)
- [**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
Niels Lohmann's avatar
Niels Lohmann committed
944
- [**Probot**](https://probot.github.io) for automating maintainer tasks such as closing stale issues, requesting missing information, or detecting toxic comments.
945
946
947
- [**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
Niels Lohmann's avatar
Niels Lohmann committed
948
- [**Wandbox**](http://melpon.org/wandbox) for [online examples](https://wandbox.org/permlink/yCTCvQi0ZVxGuL3L)
949
950


951
952
953
954
955
## 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.


Niels's avatar
Niels committed
956
957
## Notes

Niels's avatar
Niels committed
958
- The code contains numerous debug **assertions** which can be switched off by defining the preprocessor macro `NDEBUG`, see the [documentation of `assert`](http://en.cppreference.com/w/cpp/error/assert). In particular, note [`operator[]`](https://nlohmann.github.io/json/classnlohmann_1_1basic__json_a2e26bd0b0168abb61f67ad5bcd5b9fa1.html#a2e26bd0b0168abb61f67ad5bcd5b9fa1) 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_a674de1ee73e6bf4843fc5dc1351fb726.html#a674de1ee73e6bf4843fc5dc1351fb726).
959
- As the exact type of a number is not defined in the [JSON specification](http://rfc7159.net/rfc7159), 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.
Niels's avatar
Niels committed
960
961
- The library supports **Unicode input** as follows:
  - Only **UTF-8** encoded input is supported which is the default encoding for JSON according to [RFC 7159](http://rfc7159.net/rfc7159#rfc.section.8.1).
Niels Lohmann's avatar
Niels Lohmann committed
962
  - Other encodings such as Latin-1, UTF-16, or UTF-32 are not supported and will yield parse or serialization errors.
Niels's avatar
Niels committed
963
964
  - [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.
965
  - 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.
966
- The code can be compiled without C++ **runtime type identification** features; that is, you can use the `-fno-rtti` compiler flag.
Berkus Decker's avatar
Berkus Decker committed
967
- **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 an `abort()` call.
968
- 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/rfc7159.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)).
Niels's avatar
Niels committed
969

Niels's avatar
Niels committed
970

Niels's avatar
Niels committed
971
972
973
974
## Execute unit tests

To compile and run the tests, you need to execute

Niels's avatar
Niels committed
975
```sh
Niels's avatar
Niels committed
976
977
978
$ mkdir build
$ cd build
$ cmake ..
Niels Lohmann's avatar
Niels Lohmann committed
979
$ cmake --build .
Niels's avatar
Niels committed
980
$ ctest
Niels's avatar
Niels committed
981
982
```

Niels's avatar
Niels committed
983
For more information, have a look at the file [.travis.yml](https://github.com/nlohmann/json/blob/master/.travis.yml).