A C++ library for interacting with JSON.
C++ Python CMake Other
cdunn2001 Merge pull request #804 from yantaozhao/master
allow nullptr when not care the removed array value
Latest commit 2baad49 Jul 14, 2018
Permalink
Failed to load latest commit information.
devtools Restore BL's authorship attribution, and add "The Jsoncpp Authors" wh… Jul 21, 2017
doc Misc-typos (#741) Feb 9, 2018
include allow nullptr when not care the removed array value Jul 3, 2018
makefiles Normalize line endings Aug 9, 2015
pkg-config Use full CMake paths in pkg-config template Mar 9, 2017
src allow nullptr when not care the removed array value Jul 3, 2018
test Restore BL's authorship attribution, and add "The Jsoncpp Authors" wh… Jul 21, 2017
.clang-format Enabled PointerBindsToType in clang-format options. Sep 15, 2014
.gitattributes add .gitattributes Aug 9, 2015
.gitignore Update README Aug 27, 2017
.travis.yml In travis-ci, build for osx also Jun 25, 2018
AUTHORS Refactor authorship information for more technical accuracy. Apr 24, 2017
CMakeLists.txt allow out-of-source build Apr 17, 2018
LICENSE Restore BL's authorship attribution, and add "The Jsoncpp Authors" wh… Jul 21, 2017
README.md Try the way I build locally Jun 23, 2018
amalgamate.py Spelling (#703) Dec 3, 2017
appveyor.yml Enable shared libs on appveyor Jul 12, 2017
dev.makefile rsync less Sep 11, 2017
doxybuild.py Spelling (#703) Dec 3, 2017
makerelease.py Spelling (#703) Dec 3, 2017
meson.build Try to avoid empty string Jun 23, 2018
travis.before_install.linux.sh In travis-ci, build for osx also Jun 25, 2018
travis.before_install.osx.sh In travis-ci, build for osx also Jun 25, 2018
travis.install.linux.sh In travis-ci, build for osx also Jun 25, 2018
travis.install.osx.sh In travis-ci, build for osx also Jun 25, 2018
travis.sh In travis-ci, build for osx also Jun 25, 2018
version 1.8.4; soversion=20 Dec 20, 2017
version.in generate both version.h and version from CMakelists.txt Mar 6, 2015

README.md

JsonCpp

badge

JSON is a lightweight data-interchange format. It can represent numbers, strings, ordered sequences of values, and collections of name/value pairs.

JsonCpp is a C++ library that allows manipulating JSON values, including serialization and deserialization to and from strings. It can also preserve existing comment in unserialization/serialization steps, making it a convenient format to store user input files.

Documentation

JsonCpp documentation is generated using Doxygen.

A note on backward-compatibility

  • 1.y.z is built with C++11.
  • 0.y.z can be used with older compilers.
  • Major versions maintain binary-compatibility.

Contributing to JsonCpp

Building and testing with Meson/Ninja

Thanks to David Seifert (@SoapGentoo), we (the maintainers) now use meson and ninja to build for debugging, as well as for continuous integration (see travis.sh ). Other systems may work, but minor things like version strings might break.

First, install both meson (which requires Python3) and ninja. If you wish to install to a directory other than /usr/local, set an environment variable called DESTDIR with the desired path: DESTDIR=/path/to/install/dir

Then,

cd jsoncpp/
BUILD_TYPE=debug
#BUILD_TYPE=release
LIB_TYPE=shared
#LIB_TYPE=static
meson --buildtype ${BUILD_TYPE} --default-library ${LIB_TYPE} . build-${LIB_TYPE}
#ninja -v -C build-${LIB_TYPE} test # This stopped working on my Mac.
ninja -v -C build-${LIB_TYPE}
cd build-${LIB_TYPE}
meson test --no-rebuild --print-errorlogs
sudo ninja install

Building and testing with other build systems

See https://github.com/open-source-parsers/jsoncpp/wiki/Building

Running the tests manually

You need to run tests manually only if you are troubleshooting an issue.

In the instructions below, replace path/to/jsontest with the path of the jsontest executable that was compiled on your platform.

cd test
# This will run the Reader/Writer tests
python runjsontests.py path/to/jsontest

# This will run the Reader/Writer tests, using JSONChecker test suite
# (http://www.json.org/JSON_checker/).
# Notes: not all tests pass: JsonCpp is too lenient (for example,
# it allows an integer to start with '0'). The goal is to improve
# strict mode parsing to get all tests to pass.
python runjsontests.py --with-json-checker path/to/jsontest

# This will run the unit tests (mostly Value)
python rununittests.py path/to/test_lib_json

# You can run the tests using valgrind:
python rununittests.py --valgrind path/to/test_lib_json

Building the documentation

Run the Python script doxybuild.py from the top directory:

python doxybuild.py --doxygen=$(which doxygen) --open --with-dot

See doxybuild.py --help for options.

Adding a reader/writer test

To add a test, you need to create two files in test/data:

  • a TESTNAME.json file, that contains the input document in JSON format.
  • a TESTNAME.expected file, that contains a flatened representation of the input document.

The TESTNAME.expected file format is as follows:

  • Each line represents a JSON element of the element tree represented by the input document.
  • Each line has two parts: the path to access the element separated from the element value by =. Array and object values are always empty (i.e. represented by either [] or {}).
  • Element path . represents the root element, and is used to separate object members. [N] is used to specify the value of an array element at index N.

See the examples test_complex_01.json and test_complex_01.expected to better understand element paths.

Understanding reader/writer test output

When a test is run, output files are generated beside the input test files. Below is a short description of the content of each file:

  • test_complex_01.json: input JSON document.
  • test_complex_01.expected: flattened JSON element tree used to check if parsing was corrected.
  • test_complex_01.actual: flattened JSON element tree produced by jsontest from reading test_complex_01.json.
  • test_complex_01.rewrite: JSON document written by jsontest using the Json::Value parsed from test_complex_01.json and serialized using Json::StyledWritter.
  • test_complex_01.actual-rewrite: flattened JSON element tree produced by jsontest from reading test_complex_01.rewrite.
  • test_complex_01.process-output: jsontest output, typically useful for understanding parsing errors.

Using JsonCpp in your project

Amalgamated source

https://github.com/open-source-parsers/jsoncpp/wiki/Amalgamated

Other ways

If you have trouble, see the Wiki, or post a question as an Issue.

License

See the LICENSE file for details. In summary, JsonCpp is licensed under the MIT license, or public domain if desired and recognized in your jurisdiction.