my and your, since someone found this confusing

Christopher Dunn 2015-02-22 00:56:23 -06:00
parent 740effe392
commit 0b9eba1d8f

38
Home.md

@ -5,13 +5,13 @@ JSON (JavaScript Object Notation) is a lightweight data-interchange format. It c
Here is an example of JSON data: Here is an example of JSON data:
```js ```js
{ {
"encoding" : "UTF-8", "my-encoding" : "UTF-8",
"plug-ins" : [ "my-plug-ins" : [
"python", "python",
"c++", "c++",
"ruby" "ruby"
], ],
"indent" : { "length" : 3, "use_space": true } "my-indent" : { "length": 3, "use_space": true }
} }
``` ```
And here it is with ***comments***: And here it is with ***comments***:
@ -19,17 +19,17 @@ And here it is with ***comments***:
// Configuration options // Configuration options
{ {
// Default encoding for text // Default encoding for text
"encoding" : "UTF-8", "my-encoding" : "UTF-8",
// Plug-ins loaded at start-up // Plug-ins loaded at start-up
"plug-ins" : [ "my-plug-ins" : [
"python", "python",
"c++", "c++",
"ruby" "ruby"
], ],
// Tab indent size // Tab indent size
"indent" : { "length" : 3, "use_space": true } "my-indent" : { "length" : 3, "use_space": true }
} }
``` ```
Features of *jsoncpp* Features of *jsoncpp*
@ -46,25 +46,26 @@ Code example
Json::Value root; // starts as "null"; will contain the root value after parsing Json::Value root; // starts as "null"; will contain the root value after parsing
std::cin >> root; std::cin >> root;
// Get the value of the member of root named 'encoding', return 'UTF-8' if there is no // Get the value of the member of root named 'my-encoding', return 'UTF-32' if there is no
// such member. // such member.
std::string encoding = root.get("encoding", "UTF-8" ).asString(); std::string my_encoding = root.get("my-encoding", "UTF-32" ).asString();
// Get the value of the member of root named 'plug-ins', 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() ); // Get the value of the member of root named 'my-plug-ins'; return a 'null' value if
setIndentUseSpace( root["indent"].get("use_space", true).asBool() ); // there is no such member.
const Json::Value my_plugins = root["my-plug-ins"];
for ( int index = 0; index < my_plugins.size(); ++index ) // Iterates over the sequence elements.
yourib::loadPlugIn( my_plugins[index].asString() );
yourlib::setIndentLength( root["my-indent"].get("length", 3).asInt() );
yourlib::setIndentUseSpace( root["my-indent"].get("use_space", true).asBool() );
// ... // ...
// At application shutdown to make the new configuration document: // At application shutdown to make the new configuration document:
// Since Json::Value has implicit constructor for all value types, it is not // Since Json::Value has implicit constructor for all value types, it is not
// necessary to explicitly construct the Json::Value object: // necessary to explicitly construct the Json::Value object:
root["encoding"] = getCurrentEncoding(); root["encoding"] = yourlib::getCurrentEncoding();
root["indent"]["length"] = getCurrentIndentLength(); root["indent"]["length"] = yourlib::getCurrentIndentLength();
root["indent"]["use_space"] = getCurrentIndentUseSpace(); root["indent"]["use_space"] = yourlib::getCurrentIndentUseSpace();
// Make a new JSON document with the new configuration. Preserve original comments. // Make a new JSON document with the new configuration. Preserve original comments.
std::cout << root << "\n"; std::cout << root << "\n";
@ -75,6 +76,7 @@ You can also read from a file, e.g.:
#include <fstream> #include <fstream>
std::ifstream config_doc("config_doc.json", std::ifstream::binary); std::ifstream config_doc("config_doc.json", std::ifstream::binary);
config_doc >> root;
``` ```
If you need some unusual features, use *Builders*: If you need some unusual features, use *Builders*: