No Description

Milo Yip 1a825d24fa Merge pull request #1529 from rkoshy/master 2 days ago
CMakeModules ce3ca58fee Change googletest search path for cmake 3 years ago
bin 38d25d7458 Fix FileReadStream::Peek4(). 10 months ago
contrib 707fd36afa Issue #1028: Visual Studio natvis file. 2 years ago
doc 5592c2eed4 Merge pull request #1544 from fredgan/master 1 week ago
docker 680c111278 Add debian docker file for development 3 years ago
example 8973b279cf fixed Uint case in docs 1 month ago
include 1a825d24fa Merge pull request #1529 from rkoshy/master 2 days ago
test 123d7c89a4 add test for non-null-terminated token 1 month ago
thirdparty fdd2db930f Updated google test to latest commit 1 year ago
.gitattributes a62777487d Normalize line endings but not JSON files 3 years ago
.gitignore 25c1b78f3c ignore DS_Store files 1 year ago
.gitmodules 47d7320096 Update reference to gtest thirdparty module. 3 years ago
.travis.yml ed234bf749 Update .travis.yml 3 weeks ago
CHANGELOG.md 8684c9960d fix some typos 1 year ago
CMakeLists.txt 8d272e53a4 CMake: remove hardcoded CMAKECONFIG_INSTALL_DIR path 8 months ago
RapidJSON.pc.in 4a2f2729f1 Change from miloyip/rapidjson to Tencent/rapidjson 2 years ago
RapidJSONConfig.cmake.in b91c515afe update to create config file which is independent from actual install location 2 years ago
RapidJSONConfigVersion.cmake.in 8ae1c971ea Add initial CMake support 5 years ago
appveyor.yml a6be583efa Update appveyor rule to support VS2017. 1 year ago
include_dirs.js f8df637783 include folder added 3 years ago
library.json 4a2f2729f1 Change from miloyip/rapidjson to Tencent/rapidjson 2 years ago
license.txt a62777487d Normalize line endings but not JSON files 3 years ago
package.json 4a2f2729f1 Change from miloyip/rapidjson to Tencent/rapidjson 2 years ago
rapidjson.autopkg 915218878a Misc. typos 1 year ago
readme.md f0391747e6 chore: correct spelling 2 years ago
readme.zh-cn.md 2a0bc6062b Update gitbook zh-cn link 2 years ago
travis-doxygen.sh 02d4ae838c Update travis-doxygen.sh 3 weeks ago

readme.md

RapidJSON logo

Release version

A fast JSON parser/generator for C++ with both SAX/DOM style API

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. All rights reserved.

Build status

Linux Windows Coveralls
lin-badge win-badge cov-badge

Introduction

RapidJSON is a JSON parser and generator for C++. It was inspired by RapidXml.

  • RapidJSON is small but complete. It supports both SAX and DOM style API. The SAX parser is only a half thousand lines of code.

  • RapidJSON is fast. Its performance can be comparable to strlen(). It also optionally supports SSE2/SSE4.2 for acceleration.

  • RapidJSON is self-contained and header-only. It does not depend on external libraries such as BOOST. It even does not depend on STL.

  • RapidJSON is memory-friendly. Each JSON value occupies exactly 16 bytes for most 32/64-bit machines (excluding text string). By default it uses a fast memory allocator, and the parser allocates memory compactly during parsing.

  • RapidJSON is Unicode-friendly. It supports UTF-8, UTF-16, UTF-32 (LE & BE), and their detection, validation and transcoding internally. For example, you can read a UTF-8 file and let RapidJSON transcode the JSON strings into UTF-16 in the DOM. It also supports surrogates and "\u0000" (null character).

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

Highlights in v1.1 (2016-8-25)

For other changes please refer to change log.

Compatibility

RapidJSON is cross-platform. Some platform/compiler combinations which have been tested are shown as follows.

  • Visual C++ 2008/2010/2013 on Windows (32/64-bit)
  • GNU C++ 3.8.x on Cygwin
  • Clang 3.4 on Mac OS X (32/64-bit) and iOS
  • Clang 3.4 on Android NDK

Users can build and run the unit tests on their platform/compiler.

Installation

RapidJSON is a header-only C++ library. Just copy the include/rapidjson folder to system or project's include path.

RapidJSON uses following software as its dependencies:

  • CMake as a general build tool
  • (optional) Doxygen to build documentation
  • (optional) googletest for unit and performance testing

To generate user documentation and run tests please proceed with the steps below:

  1. Execute git submodule update --init to get the files of thirdparty submodules (google test).
  2. Create directory called build in rapidjson source directory.
  3. Change to build directory and run cmake .. command to configure your build. Windows users can do the same with cmake-gui application.
  4. On Windows, build the solution found in the build directory. On Linux, run 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.

Usage at a glance

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.

// rapidjson/example/simpledom/simpledom.cpp`
#include "rapidjson/document.h"
#include "rapidjson/writer.h"
#include "rapidjson/stringbuffer.h"
#include <iostream>

using namespace rapidjson;

int main() {
    // 1. Parse a JSON string into DOM.
    const char* json = "{\"project\":\"rapidjson\",\"stars\":10}";
    Document d;
    d.Parse(json);

    // 2. Modify it by DOM.
    Value& s = d["stars"];
    s.SetInt(s.GetInt() + 1);

    // 3. Stringify the DOM
    StringBuffer buffer;
    Writer<StringBuffer> writer(buffer);
    d.Accept(writer);

    // Output {"project":"rapidjson","stars":11}
    std::cout << buffer.GetString() << std::endl;
    return 0;
}

Note that this example did not handle potential errors.

The following diagram shows the process.

simpledom

More examples are available:

  • DOM API

  • SAX API

    • simplereader: Dumps all SAX events while parsing a JSON by Reader.
    • condense: A command line tool to rewrite a JSON, with all whitespaces removed.
    • pretty: A command line tool to rewrite a JSON with indents and newlines by PrettyWriter.
    • capitalize: A command line tool to capitalize strings in JSON.
    • messagereader: Parse a JSON message with SAX API.
    • serialize: Serialize a C++ object into JSON with SAX API.
    • jsonx: Implements a 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.
  • Schema

    • schemavalidator : A command line tool to validate a JSON with a JSON schema.
  • Advanced

    • prettyauto: A modified version of pretty to automatically handle JSON with any UTF encodings.
    • parsebyparts: Implements an AsyncDocumentParser which can parse JSON in parts, using C++11 thread.
    • filterkey: A command line tool to remove all values with user-specified key.
    • filterkeydom: Same tool as above, but it demonstrates how to use a generator to populate a Document.