JSON Toolkit is a swiss-army knife for JSON programming in modern C++. It comes with a built-in parser and growing support for standards such as JSON Schema, JSON Pointer, JSONL, and more. It targets C++20 and supports the Clang, GCC, and MSVC compilers on macOS, GNU/Linux, FreeBSD, Windows, and Unikraft.

Installation

As a git submodule

# Add the project as a submodule, in this case to deps/jsontoolkit
$ git submodule add https://github.com/sourcemeta/jsontoolkit.git deps/jsontoolkit
 
# Add the project as a CMake subdirectory
add_subdirectory("${PROJECT_SOURCE_DIR}/deps/jsontoolkit")
 
# Link your targets accordingly
target_link_libraries(my_executable_or_library PUBLIC sourcemeta::jsontoolkit::json)
target_link_libraries(my_executable_or_library PUBLIC sourcemeta::jsontoolkit::jsonschema)
target_link_libraries(my_executable_or_library PUBLIC sourcemeta::jsontoolkit::jsonpointer)
target_link_libraries(my_executable_or_library PUBLIC sourcemeta::jsontoolkit::jsonl)

Using FetchContent

cmake_minimum_required(VERSION 3.14)
project(my_project)
set(CMAKE_CXX_STANDARD 20)
 
include(FetchContent)
FetchContent_Declare(
  jsontoolkit
  URL https://github.com/sourcemeta/jsontoolkit/archive/<commit-sha>.zip
  DOWNLOAD_EXTRACT_TIMESTAMP NO)
FetchContent_MakeAvailable(jsontoolkit)
 
add_executable(my_example ...)
target_link_libraries(my_example PUBLIC sourcemeta::jsontoolkit::json)
target_link_libraries(my_example PUBLIC sourcemeta::jsontoolkit::jsonschema)
target_link_libraries(my_example PUBLIC sourcemeta::jsontoolkit::jsonpointer)
target_link_libraries(my_example PUBLIC sourcemeta::jsontoolkit::jsonl)

Using find_package

Assuming you have installed JSON Toolkit in a place where CMake can find the package config file:

find_package(JSONToolkit REQUIRED)
 
# This package also supports component-based inclusion
find_package(JSONToolkit REQUIRED COMPONENTS json jsonschema jsonpointer jsonl)
 
# Link your targets accordingly
target_link_libraries(my_executable_or_library PUBLIC sourcemeta::jsontoolkit::json)
target_link_libraries(my_executable_or_library PUBLIC sourcemeta::jsontoolkit::jsonschema)
target_link_libraries(my_executable_or_library PUBLIC sourcemeta::jsontoolkit::jsonpointer)
target_link_libraries(my_executable_or_library PUBLIC sourcemeta::jsontoolkit::jsonl)

Using Unikraft

On your Kraftfile libraries, declare JSON Toolkit as follows:

libraries:
  ...
  jsontoolkit:
    source: https://github.com/sourcemeta/jsontoolkit.git
    version: <sha-or-tag>

Then, on your target kconfig configuration, specify:

- CONFIG_LIBJSONTOOLKIT=y

CMake

Options

Option	Type	Default	Description
`JSONTOOLKIT_URI`	Boolean	`ON`	Build the JSON Toolkit URI library
`JSONTOOLKIT_JSON`	Boolean	`ON`	Build the JSON Toolkit JSON library
`JSONTOOLKIT_JSONSCHEMA`	Boolean	`ON`	Build the JSON Toolkit JSON Schema library
`JSONTOOLKIT_JSONPOINTER`	Boolean	`ON`	Build the JSON Toolkit JSON Pointer library
`JSONTOOLKIT_JSONL`	Boolean	`ON`	Build the JSON Toolkit JSONL library
`JSONTOOLKIT_TESTS`	Boolean	`OFF`	Build the JSON Toolkit tests
`JSONTOOLKIT_DOCS`	Boolean	`OFF`	Build the JSON Toolkit docs
`JSONTOOLKIT_INSTALL`	Boolean	`ON`	Install the JSON Toolkit library
`JSONTOOLKIT_ADDRESS_SANITIZER`	Boolean	`OFF`	Enable the address sanitizer
`JSONTOOLKIT_UNDEFINED_SANITIZER`	Boolean	`OFF`	Enable the undefined behavior sanitizer

Components

If you install JSON Toolkit from source, keep in mind that the project is split into a set of CMake components:

Component	Description
`sourcemeta_jsontoolkit`	The core JSON Toolkit libraries
`sourcemeta_jsontoolkit_dev`	The JSON Toolkit headers and development files

Contributing

JSON Toolkit makes use of the CMake build system. You can configure, build and test the project as follows:

cmake -S . -B ./build \
  -DCMAKE_BUILD_TYPE:STRING=<Debug|Release> \
  -DCMAKE_COMPILE_WARNING_AS_ERROR:BOOL=ON \
  -DJSONTOOLKIT_DOCS:BOOL=ON \
  -DJSONTOOLKIT_TESTS:BOOL=ON
# Format the code
cmake --build ./build --config <Debug|Release> --target clang_format
# Build the project
cmake --build ./build --config <Debug|Release>
# Run the test suite
ctest --test-dir ./build --build-config <Debug|Release> --output-on-failure --progress

Or simply run:

# On UNIX-based systems
make
# On Windows
nmake

Table of Contents