Both CMake and Meson tools are capable of generating a variety of build environments for you preferred development environment. Using cmake or meson you can generate an XCode, Visual Studio, Unix Makefile, Ninja, or other environment that fits your needs.
An example of a common Meson/Ninja environment is described next.
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_scripts/meson_builder.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} ninja -C build-static/ test # Or #cd build-${LIB_TYPE} #meson test --no-rebuild --print-errorlogs sudo ninja install
See https://github.com/open-source-parsers/jsoncpp/wiki/Building
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
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.
To add a test, you need to create two files in test/data:
TESTNAME.json
file, that contains the input document in JSON format.TESTNAME.expected
file, that contains a flatened representation of the input document.The TESTNAME.expected
file format is as follows:
=
. Array and object values are always empty (i.e. represented by either []
or {}
)..
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.
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.Consumers of this library require a strict approach to incrementing versioning of the JsonCpp library. Currently, we follow the below set of rules:
Generally, JsonCpp's style guide has been pretty relaxed, with the following common themes:
nullptr
over NULL
.For an example:
bool Reader::decodeNumber(Token& token) { Value decoded; if (!decodeNumber(token, decoded)) return false; currentValue().swapPayload(decoded); currentValue().setOffsetStart(token.start_ - begin_); currentValue().setOffsetLimit(token.end_ - begin_); return true; }
Before submitting your code, ensure that you meet the versioning requirements above, follow the style guide of the file you are modifying (or the above rules for new files), and run clang format. Meson exposes clang format with the following command:
ninja -v -C build-${LIB_TYPE}/ clang-format