diff options
author | Leon Scroggins III <scroggo@google.com> | 2014-05-28 15:19:42 -0400 |
---|---|---|
committer | Leon Scroggins III <scroggo@google.com> | 2014-05-29 15:15:39 -0400 |
commit | f59fb0e83fd0a4b41700d3f5eebdc8d21b173c2e (patch) | |
tree | 292a5d15dc273857c0579cf03c1b0b94e42f5b53 /doc | |
parent | 76748b606d64b80aa5deca02d3dfd87ac165bfdd (diff) | |
download | jsoncpp-f59fb0e83fd0a4b41700d3f5eebdc8d21b173c2e.tar.gz |
Check in jsoncpp.
Check in ab1e40f3bce061ea6f9bdc60351d6cde2a4f872b from
https://chromium.googlesource.com/external/jsoncpp/jsoncpp.git
This is the version used by Skia's test suite.
BUG:15087860
Change-Id: I16bf6ac927fa025b6527b48221d749484e1a04f4
Diffstat (limited to 'doc')
-rw-r--r-- | doc/header.html | 24 | ||||
-rw-r--r-- | doc/jsoncpp.dox | 126 | ||||
-rw-r--r-- | doc/roadmap.dox | 37 |
3 files changed, 187 insertions, 0 deletions
diff --git a/doc/header.html b/doc/header.html new file mode 100644 index 0000000..1a6ad61 --- /dev/null +++ b/doc/header.html @@ -0,0 +1,24 @@ +<html> +<head> +<title> +JsonCpp - JSON data format manipulation library +</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head> + +<body bgcolor="#ffffff"> +<table width="100%"> + <tr> + <td width="40%" align="left" valign="center"> + <a href="http://sourceforge.net/projects/jsoncpp/"> + JsonCpp project page + </a> + </td> + <td width="40%" align="right" valign="center"> + <a href="http://jsoncpp.sourceforge.net">JsonCpp home page</a> + </td> + </tr> +</table> + +<hr> diff --git a/doc/jsoncpp.dox b/doc/jsoncpp.dox new file mode 100644 index 0000000..97cc108 --- /dev/null +++ b/doc/jsoncpp.dox @@ -0,0 +1,126 @@ +/** +\mainpage +\section _intro Introduction + +<a HREF="http://www.json.org/">JSON (JavaScript Object Notation)</a> + is a lightweight data-interchange format. +It can represent integer, real number, string, an ordered sequence of value, and +a collection of name/value pairs. + +Here is an example of JSON data: +\verbatim +// Configuration options +{ + // Default encoding for text + "encoding" : "UTF-8", + + // Plug-ins loaded at start-up + "plug-ins" : [ + "python", + "c++", + "ruby" + ], + + // Tab indent size + "indent" : { "length" : 3, "use_space": true } +} +\endverbatim + +\section _features Features +- read and write JSON document +- attach C and C++ style comments to element during parsing +- rewrite JSON document preserving original comments + +Notes: Comments used to be supported in JSON but where removed for +portability (C like comments are not supported in Python). Since +comments are useful in configuration/input file, this feature was +preserved. + +\section _example Code example + +\code +Json::Value root; // will contains the root value after parsing. +Json::Reader reader; +bool parsingSuccessful = reader.parse( config_doc, root ); +if ( !parsingSuccessful ) +{ + // report to the user the failure and their locations in the document. + std::cout << "Failed to parse configuration\n" + << reader.getFormattedErrorMessages(); + return; +} + +// Get the value of the member of root named 'encoding', return 'UTF-8' if there is no +// such member. +std::string encoding = root.get("encoding", "UTF-8" ).asString(); +// Get the value of the member of root named 'encoding', return a 'null' value if +// there is no such member. +const Json::Value plugins = root["plug-ins"]; +for ( int index = 0; index < plugins.size(); ++index ) // Iterates over the sequence elements. + loadPlugIn( plugins[index].asString() ); + +setIndentLength( root["indent"].get("length", 3).asInt() ); +setIndentUseSpace( root["indent"].get("use_space", true).asBool() ); + +// ... +// At application shutdown to make the new configuration document: +// Since Json::Value has implicit constructor for all value types, it is not +// necessary to explicitly construct the Json::Value object: +root["encoding"] = getCurrentEncoding(); +root["indent"]["length"] = getCurrentIndentLength(); +root["indent"]["use_space"] = getCurrentIndentUseSpace(); + +Json::StyledWriter writer; +// Make a new JSON document for the configuration. Preserve original comments. +std::string outputConfig = writer.write( root ); + +// You can also use streams. This will put the contents of any JSON +// stream at a particular sub-value, if you'd like. +std::cin >> root["subtree"]; + +// And you can write to a stream, using the StyledWriter automatically. +std::cout << root; +\endcode + +\section _pbuild Build instructions +The build instructions are located in the file +<a HREF="README.txt">README.txt</a> in the top-directory of the project. + +Permanent link to the latest revision of the file in subversion: +<a HREF="http://jsoncpp.svn.sourceforge.net/viewvc/jsoncpp/trunk/jsoncpp/README.txt?view=markup">latest README.txt</a> + +\section _pdownload Download +The sources can be downloaded from +<a HREF="http://sourceforge.net/projects/jsoncpp/files/">SourceForge download page</a>. + +The latest version of the source is available in the project's subversion repository: +<a HREF="http://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/trunk/"> +http://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/trunk/</a> + +To checkout the source, see the following +<a HREF="http://sourceforge.net/scm/?type=svn&group_id=144446">instructions</a>. + +\section _news What's New? +The description of latest changes can be found in +<a HREF="NEWS.txt">NEWS.txt</a> in the top-directory of the project. + +Permanent link to the latest revision of the file in subversion: +<a HREF="http://svn.sourceforge.net/viewcvs.cgi/jsoncpp/README.txt?view=markup">latest NEWS.txt</a> + +\section _plinks Project links +- <a HREF="http://jsoncpp.sourceforge.net">json-cpp home</a> +- <a HREF="http://www.sourceforge.net/projects/jsoncpp/">json-cpp sourceforge project</a> + +\section _rlinks Related links +- <a HREF="http://www.json.org/">JSON</a> Specification and alternate language implementations. +- <a HREF="http://www.yaml.org/">YAML</a> A data format designed for human readability. +- <a HREF="http://www.cl.cam.ac.uk/~mgk25/unicode.html">UTF-8 and Unicode FAQ</a>. + +\section _license License +See file <a HREF="LICENSE">LICENSE</a> in the top-directory of the project. + +Basically JsonCpp is licensed under MIT license, or public domain if desired +and recognized in your jurisdiction. + +\author Baptiste Lepilleur <blep@users.sourceforge.net> +*/ diff --git a/doc/roadmap.dox b/doc/roadmap.dox new file mode 100644 index 0000000..e6fc17a --- /dev/null +++ b/doc/roadmap.dox @@ -0,0 +1,37 @@ +/*! \page roadmap JsonCpp roadmap + \section ms_release Makes JsonCpp ready for release + - Build system clean-up: + - Fix build on Windows (shared-library build is broken) + - Add enable/disable flag for static and shared library build + - Enhance help + - Platform portability check: (Notes: was ok on last check) + - linux/gcc, + - solaris/cc, + - windows/msvc678, + - aix/vacpp + - Add JsonCpp version to header as numeric for use in preprocessor test + - Remove buggy experimental hash stuff + \section ms_strict Adds a strict mode to reader/parser + Strict JSON support as specific in RFC 4627 (http://www.ietf.org/rfc/rfc4627.txt?number=4627). + - Enforce only object or array as root element + - Disable comment support + - Get jsonchecker failing tests to pass in strict mode + \section ms_writer Writter control + Provides more control to determine how specific items are serialized when JSON allow choice: + - Optionally allow escaping of non-ASCII characters using unicode escape sequence "\\u". + - Optionally allow escaping of "/" using "\/". + \section ms_separation Expose json reader/writer API that do not impose using Json::Value. + Some typical use-case involve an application specific structure to/from a JSON document. + - Event base parser to allow unserializing a Json document directly in datastructure instead of + using the intermediate Json::Value. + - Stream based parser to serialized a Json document without using Json::Value as input. + - Performance oriented parser/writer: + - Provides an event based parser. Should allow pulling & skipping events for ease of use. + - Provides a JSON document builder: fast only. + \section ms_perfo Performance tuning + - Provides support for static property name definition avoiding allocation + - Static property dictionnary can be provided to JSON reader + - Performance scenario & benchmarking + \section testing Testing + - Adds more tests for unicode parsing (e.g. including surrogate and error detection). +*/ |