Tencent is pleased to support the open source community by making RapidJSON available.
Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip.
Linux | Windows | Coveralls |
---|---|---|
RapidJSON is a JSON parser and generator for C++. It was inspired by RapidXml.
strlen()
. It also optionally supports SSE2/SSE4.2 for acceleration.More features can be read here.
JSON(JavaScript Object Notation) is a light-weight data exchange format. RapidJSON should be in full compliance with RFC7159/ECMA-404, with optional support of relaxed syntax. More information about JSON can be obtained at
Value
from 24 bytes to 16 bytes in x86-64 architecture.For other changes please refer to change log.
RapidJSON is cross-platform. Some platform/compiler combinations which have been tested are shown as follows.
Users can build and run the unit tests on their platform/compiler.
RapidJSON is a header-only C++ library. Just copy the include/rapidjson
folder to system or project's include path.
Alternatively, if you are using the vcpkg dependency manager you can download and install rapidjson with CMake integration in a single command:
RapidJSON uses following software as its dependencies:
To generate user documentation and run tests please proceed with the steps below:
git submodule update --init
to get the files of thirdparty submodules (google test).build
in rapidjson source directory.build
directory and run cmake ..
command to configure your build. Windows users can do the same with cmake-gui application.make
from the build directory.On successful build you will find compiled test and example binaries in bin
directory. The generated documentation will be available in doc/html
directory of the build tree. To run tests after finished build please run make test
or ctest
from your build tree. You can get detailed output using ctest -V
command.
It is possible to install library system-wide by running make install
command from the build tree with administrative privileges. This will install all files according to system preferences. Once RapidJSON is installed, it is possible to use it from other CMake projects by adding find_package(RapidJSON)
line to your CMakeLists.txt.
This simple example parses a JSON string into a document (DOM), make a simple modification of the DOM, and finally stringify the DOM to a JSON string.
Note that this example did not handle potential errors.
The following diagram shows the process.
More examples are available:
Reader
.PrettyWriter
.JsonxWriter
which stringify SAX events into JSONx (a kind of XML) format. The example is a command line tool which converts input JSON into JSONx format.AsyncDocumentParser
which can parse JSON in parts, using C++11 thread.Document
.RapidJSON welcomes contributions. When contributing, please follow the code below.
Feel free to submit issues and enhancement requests.
Please help us by providing minimal reproducible examples, because source code is easier to let other people understand what happens. For crash problems on certain platforms, please bring stack dump content with the detail of the OS, compiler, etc.
Please try breakpoint debugging first, tell us what you found, see if we can start exploring based on more information been prepared.
In general, we follow the "fork-and-pull" Git workflow.
unittest
and preftest
, please add test case for each new feature or bug-fix if needed.NOTE: Be sure to merge the latest from "upstream" before making a pull request!
You can copy and paste the license summary from below.