|
|
@@ -1,24 +1,24 @@
|
|
|
[](https://github.com/nlohmann/json/releases)
|
|
|
|
|
|
[](https://travis-ci.org/nlohmann/json)
|
|
|
-[](https://ci.appveyor.com/project/nlohmann/json)
|
|
|
+[](https://ci.appveyor.com/project/nlohmann/json)
|
|
|
[](https://coveralls.io/r/nlohmann/json)
|
|
|
-[](https://scan.coverity.com/projects/nlohmann-json)
|
|
|
-[](http://melpon.org/wandbox/permlink/p5o4znPnGHJpDVqN)
|
|
|
+[](http://melpon.org/wandbox/permlink/fsf5FqYe6GoX68W6)
|
|
|
[](http://nlohmann.github.io/json)
|
|
|
[](https://raw.githubusercontent.com/nlohmann/json/master/LICENSE.MIT)
|
|
|
[](https://github.com/nlohmann/json/releases)
|
|
|
[](http://github.com/nlohmann/json/issues)
|
|
|
+[](https://bestpractices.coreinfrastructure.org/projects/289)
|
|
|
|
|
|
## 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:
|
|
|
|
|
|
-- **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 know, what I mean.
|
|
|
+- **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/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.
|
|
|
|
|
|
-- **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.
|
|
|
+- **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).
|
|
|
|
|
|
Other aspects were not so important to us:
|
|
|
|
|
|
@@ -283,8 +283,8 @@ 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); // only one entry for "one" is used
|
|
|
-// maybe ["one", "two", "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
|
|
|
@@ -416,7 +416,13 @@ The following compilers are currently used in continuous integration at [Travis]
|
|
|
| GCC 4.9.3 | Ubuntu 14.04.4 LTS | g++-4.9 (Ubuntu 4.9.3-8ubuntu2~14.04) 4.9.3 |
|
|
|
| GCC 5.3.0 | Ubuntu 14.04.4 LTS | g++-5 (Ubuntu 5.3.0-3ubuntu1~14.04) 5.3.0 20151204 |
|
|
|
| GCC 6.1.1 | Ubuntu 14.04.4 LTS | g++-6 (Ubuntu 6.1.1-3ubuntu11~14.04.1) 6.1.1 20160511 |
|
|
|
+| Clang 3.6.0 | Ubuntu 14.04.4 LTS | clang version 3.6.0 (tags/RELEASE_360/final) |
|
|
|
+| Clang 3.6.1 | Ubuntu 14.04.4 LTS | clang version 3.6.1 (tags/RELEASE_361/final) |
|
|
|
+| Clang 3.6.2 | Ubuntu 14.04.4 LTS | clang version 3.6.2 (tags/RELEASE_362/final) |
|
|
|
+| Clang 3.7.0 | Ubuntu 14.04.4 LTS | clang version 3.7.0 (tags/RELEASE_370/final) |
|
|
|
+| Clang 3.7.1 | Ubuntu 14.04.4 LTS | clang version 3.7.1 (tags/RELEASE_371/final) |
|
|
|
| Clang 3.8.0 | Ubuntu 14.04.4 LTS | clang version 3.8.0 (tags/RELEASE_380/final) |
|
|
|
+| Clang 3.8.1 | Ubuntu 14.04.4 LTS | clang version 3.8.1 (tags/RELEASE_381/final) |
|
|
|
| Clang Xcode 6.1 | Darwin Kernel Version 13.4.0 (OSX 10.9.5) | Apple LLVM version 6.0 (clang-600.0.54) (based on LLVM 3.5svn) |
|
|
|
| Clang Xcode 6.2 | Darwin Kernel Version 13.4.0 (OSX 10.9.5) | Apple LLVM version 6.0 (clang-600.0.57) (based on LLVM 3.5svn) |
|
|
|
| Clang Xcode 6.3 | Darwin Kernel Version 14.3.0 (OSX 10.10.3) | Apple LLVM version 6.1.0 (clang-602.0.49) (based on LLVM 3.6.0svn) |
|
|
|
@@ -424,7 +430,7 @@ The following compilers are currently used in continuous integration at [Travis]
|
|
|
| Clang Xcode 7.1 | Darwin Kernel Version 14.5.0 (OSX 10.10.5) | Apple LLVM version 7.0.0 (clang-700.1.76) |
|
|
|
| Clang Xcode 7.2 | Darwin Kernel Version 15.0.0 (OSX 10.10.5) | Apple LLVM version 7.0.2 (clang-700.1.81) |
|
|
|
| Clang Xcode 7.3 | Darwin Kernel Version 15.0.0 (OSX 10.10.5) | Apple LLVM version 7.3.0 (clang-703.0.29) |
|
|
|
-| Clang Xcode 8.0 | Darwin Kernel Version 15.5.0 (OSX 10.11.5) | Apple LLVM version 8.0.0 (clang-800.0.24.1) |
|
|
|
+| Clang Xcode 8.0 | Darwin Kernel Version 15.6.0 (OSX 10.11.6) | Apple LLVM version 8.0.0 (clang-800.0.38) |
|
|
|
| Visual Studio 14 2015 | Windows Server 2012 R2 (x64) | Microsoft (R) Build Engine version 14.0.25123.0 |
|
|
|
|
|
|
|
|
|
@@ -486,14 +492,26 @@ I deeply appreciate the help of the following people.
|
|
|
- [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).
|
|
|
+- [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.
|
|
|
+- [Denis Andrejew](https://github.com/seeekr) fixed a grammar issue in the README file.
|
|
|
|
|
|
Thanks a lot for helping out!
|
|
|
|
|
|
|
|
|
## Notes
|
|
|
|
|
|
-- 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).
|
|
|
+- 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).
|
|
|
- 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.
|
|
|
+- 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).
|
|
|
+ - Other encodings such as Latin-1, UTF-16, or UTF-32 are not supported and will yield parse 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.
|
|
|
|
|
|
|
|
|
## Execute unit tests
|
|
|
@@ -501,11 +519,20 @@ Thanks a lot for helping out!
|
|
|
To compile and run the tests, you need to execute
|
|
|
|
|
|
```sh
|
|
|
-$ make
|
|
|
-$ ./json_unit "*"
|
|
|
+$ make check
|
|
|
|
|
|
===============================================================================
|
|
|
-All tests passed (8905012 assertions in 32 test cases)
|
|
|
+All tests passed (8905491 assertions in 36 test cases)
|
|
|
+```
|
|
|
+
|
|
|
+Alternatively, you can use [CMake](https://cmake.org) and run
|
|
|
+
|
|
|
+```sh
|
|
|
+$ mkdir build
|
|
|
+$ cd build
|
|
|
+$ cmake ..
|
|
|
+$ make
|
|
|
+$ ctest
|
|
|
```
|
|
|
|
|
|
For more information, have a look at the file [.travis.yml](https://github.com/nlohmann/json/blob/master/.travis.yml).
|
Adam Ierymenko