jsoncpp/doc/jsoncpp.dox

138 lines
4.8 KiB
Plaintext
Raw Normal View History

2007-06-14 19:58:59 +02:00
/**
\mainpage
\section _intro Introduction
<a HREF="http://www.json.org/">JSON (JavaScript Object Notation)</a>
is a lightweight data-interchange format.
Here is an example of JSON data:
\verbatim
2015-01-25 19:19:30 +01:00
{
"encoding" : "UTF-8",
"plug-ins" : [
"python",
"c++",
"ruby"
],
"indent" : { "length" : 3, "use_space": true }
}
\endverbatim
<b>JsonCpp</b> supports comments as <i>meta-data</i>:
\code
2007-06-14 19:58:59 +02:00
// Configuration options
{
// Default encoding for text
"encoding" : "UTF-8",
// Plug-ins loaded at start-up
"plug-ins" : [
"python",
2015-01-25 19:19:30 +01:00
"c++", // trailing comment
2007-06-14 19:58:59 +02:00
"ruby"
],
// Tab indent size
2015-01-25 19:19:30 +01:00
// (multi-line comment)
"indent" : { /*embedded comment*/ "length" : 3, "use_space": true }
2007-06-14 19:58:59 +02:00
}
2015-01-25 19:19:30 +01:00
\endcode
2007-06-14 19:58:59 +02:00
\section _features Features
- read and write JSON document
2014-07-05 21:13:37 +02:00
- attach C++ style comments to element during parsing
2007-06-14 19:58:59 +02:00
- rewrite JSON document preserving original comments
2015-01-25 19:19:30 +01:00
Notes: Comments used to be supported in JSON but were 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
2007-06-14 19:58:59 +02:00
\code
2015-02-09 08:29:43 +01:00
Json::Value root; // 'root' will contain the root value after parsing.
std::cin >> root; // Or see CharReaderBuilder.
2007-06-14 19:58:59 +02:00
// 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() );
// Since Json::Value has implicit constructor for all value types, it is not
// necessary to explicitly construct the Json::Value object:
2007-06-14 19:58:59 +02:00
root["encoding"] = getCurrentEncoding();
root["indent"]["length"] = getCurrentIndentLength();
root["indent"]["use_space"] = getCurrentIndentUseSpace();
2015-01-26 18:23:31 +01:00
// (NEW IN 1.4.0)
2015-02-09 08:29:43 +01:00
// To write into a stream with minimal memory overhead,
// create a Builder for a StreamWriter.
2015-01-26 18:04:03 +01:00
Json::StreamWriterBuilder builder;
builder.indentation_ = " "; // or whatever you like
// Then build a StreamWriter.
std::shared_ptr<Json::StreamWriter> writer(
2015-01-26 02:20:43 +01:00
builder.newStreamWriter( &std::cout ) );
2007-06-14 19:58:59 +02:00
// Make a new JSON document for the configuration. Preserve original comments.
writer->write( root );
// If you like the defaults, you can insert directly into a stream.
std::cout << root;
2007-06-14 19:58:59 +02:00
// If desired, remember to add a linefeed and flush.
std::cout << std::endl;
2015-01-26 02:20:43 +01:00
// Of course, you can write to `std::ostringstream` if you prefer. Or
// use `writeString()` for convenience.
std::string document = Json::writeString( root, builder );
// You can also read from a stream. This will put the contents of any JSON
2007-06-14 19:58:59 +02:00
// stream at a particular sub-value, if you'd like.
std::cin >> root["subtree"];
\endcode
2010-03-12 11:17:46 +01:00
\section _pbuild Build instructions
The build instructions are located in the file
2014-07-06 05:44:33 +02:00
<a HREF="https://github.com/open-source-parsers/jsoncpp/blob/master/README.md">README.md</a> in the top-directory of the project.
2007-06-14 19:58:59 +02:00
2014-07-05 21:13:37 +02:00
The latest version of the source is available in the project's GitHub repository:
<a HREF="https://github.com/open-source-parsers/jsoncpp/">
2014-07-05 21:13:37 +02:00
jsoncpp</a>
2007-06-14 19:58:59 +02:00
\section _news What's New?
The description of latest changes can be found in
2014-07-06 05:44:33 +02:00
<a HREF="https://github.com/open-source-parsers/jsoncpp/wiki/NEWS">
the NEWS wiki
</a>.
2007-06-14 19:58:59 +02:00
\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>.
2014-07-05 21:13:37 +02:00
\section _plinks Old project links
- <a href="https://sourceforge.net/projects/jsoncpp/">https://sourceforge.net/projects/jsoncpp/</a>
- <a href="http://jsoncpp.sourceforge.net">http://jsoncpp.sourceforge.net</a>
- <a href="http://sourceforge.net/projects/jsoncpp/files/">http://sourceforge.net/projects/jsoncpp/files/</a>
- <a href="http://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/trunk/">http://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/trunk/</a>
- <a href="http://jsoncpp.sourceforge.net/old.html">http://jsoncpp.sourceforge.net/old.html</a>
2007-06-14 19:58:59 +02:00
\section _license License
See file <a href="https://github.com/open-source-parsers/jsoncpp/blob/master/LICENSE"><code>LICENSE</code></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.
2007-06-14 19:58:59 +02:00
2014-07-05 21:13:37 +02:00
\author Baptiste Lepilleur <blep@users.sourceforge.net> (originator)
2015-02-09 07:46:20 +01:00
\version \include version
\sa version.h
2007-06-14 19:58:59 +02:00
*/