diff options
Diffstat (limited to 'sl4n/rapidjson/readme.md')
-rw-r--r-- | sl4n/rapidjson/readme.md | 129 |
1 files changed, 0 insertions, 129 deletions
diff --git a/sl4n/rapidjson/readme.md b/sl4n/rapidjson/readme.md deleted file mode 100644 index 8682df1..0000000 --- a/sl4n/rapidjson/readme.md +++ /dev/null @@ -1,129 +0,0 @@ -![](doc/logo/rapidjson.png) - -![](https://img.shields.io/badge/release-v1.0.2-blue.png) - -## 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. - -* [RapidJSON GitHub](https://github.com/miloyip/rapidjson/) -* RapidJSON Documentation - * [English](http://rapidjson.org/) - * [简体中文](http://rapidjson.org/zh-cn/) - * [GitBook](https://www.gitbook.com/book/miloyip/rapidjson/) with downloadable PDF/EPUB/MOBI, without API reference. - -## Build status - -| [Linux][lin-link] | [Windows][win-link] | [Coveralls][cov-link] | -| :---------------: | :-----------------: | :-------------------: | -| ![lin-badge] | ![win-badge] | ![cov-badge] | - -[lin-badge]: https://travis-ci.org/miloyip/rapidjson.png?branch=master "Travis build status" -[lin-link]: https://travis-ci.org/miloyip/rapidjson "Travis build status" -[win-badge]: https://ci.appveyor.com/api/projects/status/u658dcuwxo14a8m9/branch/master "AppVeyor build status" -[win-link]: https://ci.appveyor.com/project/miloyip/rapidjson/branch/master "AppVeyor build status" -[cov-badge]: https://coveralls.io/repos/miloyip/rapidjson/badge.png?branch=master -[cov-link]: https://coveralls.io/r/miloyip/rapidjson?branch=master - -## Introduction - -RapidJSON is a JSON parser and generator for C++. It was inspired by [RapidXml](http://rapidxml.sourceforge.net/). - -* 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. 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/20 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](doc/features.md). - -JSON(JavaScript Object Notation) is a light-weight data exchange format. RapidJSON should be in fully compliance with RFC7159/ECMA-404. More information about JSON can be obtained at -* [Introducing JSON](http://json.org/) -* [RFC7159: The JavaScript Object Notation (JSON) Data Interchange Format](http://www.ietf.org/rfc/rfc7159.txt) -* [Standard ECMA-404: The JSON Data Interchange Format](http://www.ecma-international.org/publications/standards/Ecma-404.htm) - -## 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](http://www.cmake.org) as a general build tool -* (optional)[Doxygen](http://www.doxygen.org) to build documentation -* (optional)[googletest](https://code.google.com/p/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 successfull 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. - -~~~~~~~~~~cpp -// 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](doc/diagram/simpledom.png) - -More [examples](https://github.com/miloyip/rapidjson/tree/master/example) are available. |