<!DOCTYPE html>
< html >
< head >
< meta charset = 'utf-8' >
< meta http-equiv = "X-UA-Compatible" content = "chrome=1" >
< meta name = "description" content = "parson : Lightweight json library written in C." >
< link rel = "stylesheet" type = "text/css" media = "screen" href = "stylesheets/stylesheet.css" >
< title > parson< / title >
< / head >
< body >
<!-- HEADER -->
< div id = "header_wrap" class = "outer" >
< header class = "inner" >
< a id = "forkme_banner" href = "https://github.com/kgabis/parson" > View on GitHub< / a >
< h1 id = "project_title" > parson< / h1 >
< h2 id = "project_tagline" > Lightweight json library written in C.< / h2 >
< section id = "downloads" >
< a class = "zip_download_link" href = "https://github.com/kgabis/parson/zipball/master" > Download this project as a .zip file< / a >
< a class = "tar_download_link" href = "https://github.com/kgabis/parson/tarball/master" > Download this project as a tar.gz file< / a >
< / section >
< / header >
< / div >
<!-- MAIN CONTENT -->
< div id = "main_content_wrap" class = "outer" >
< section id = "main_content" class = "inner" >
< h2 >
< a id = "about" class = "anchor" href = "#about" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > About< / h2 >
< p > Parson is a lighweight < a href = "http://json.org" > json< / a > library written in C.< / p >
< h2 >
< a id = "features" class = "anchor" href = "#features" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > Features< / h2 >
< ul >
< li > Full JSON support< / li >
< li > Lightweight (only 2 files)< / li >
< li > Simple API< / li >
< li > Addressing json values with dot notation (similiar to C structs or objects in most OO languages, e.g. "objectA.objectB.value")< / li >
< li > C89 compatible< / li >
< li > Test suites< / li >
< / ul >
< h2 >
< a id = "installation" class = "anchor" href = "#installation" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > Installation< / h2 >
< p > Run:< / p >
< pre > < code > git clone https://github.com/kgabis/parson.git
< / code > < / pre >
< p > and copy parson.h and parson.c to you source code tree.< / p >
< p > Run < code > make test< / code > to compile and run tests.< / p >
< h2 >
< a id = "examples" class = "anchor" href = "#examples" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > Examples< / h2 >
< h3 >
< a id = "parsing-json" class = "anchor" href = "#parsing-json" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > Parsing JSON< / h3 >
< p > Here is a function, which prints basic commit info (date, sha and author) from a github repository. < / p >
< div class = "highlight highlight-source-c" > < pre > < span class = "pl-k" > void< / span > < span class = "pl-en" > print_commits_info< / span > (< span class = "pl-k" > const< / span > < span class = "pl-k" > char< / span > *username, < span class = "pl-k" > const< / span > < span class = "pl-k" > char< / span > *repo) {
JSON_Value *root_value;
JSON_Array *commits;
JSON_Object *commit;
< span class = "pl-c1" > size_t< / span > i;
< span class = "pl-k" > char< / span > curl_command[< span class = "pl-c1" > 512< / span > ];
< span class = "pl-k" > char< / span > cleanup_command[< span class = "pl-c1" > 256< / span > ];
< span class = "pl-k" > char< / span > output_filename[] = < span class = "pl-s" > < span class = "pl-pds" > "< / span > commits.json< span class = "pl-pds" > "< / span > < / span > ;
< span class = "pl-c" > /* it ain't pretty, but it's not a libcurl tutorial */< / span >
< span class = "pl-c1" > sprintf< / span > (curl_command,
< span class = "pl-s" > < span class = "pl-pds" > "< / span > curl -s < span class = "pl-cce" > \"< / span > https://api.github.com/repos/< span class = "pl-c1" > %s< / span > /< span class = "pl-c1" > %s< / span > /commits< span class = "pl-cce" > \"< / span > > < span class = "pl-c1" > %s< / span > < span class = "pl-pds" > "< / span > < / span > ,
username, repo, output_filename);
< span class = "pl-c1" > sprintf< / span > (cleanup_command, < span class = "pl-s" > < span class = "pl-pds" > "< / span > rm -f < span class = "pl-c1" > %s< / span > < span class = "pl-pds" > "< / span > < / span > , output_filename);
< span class = "pl-c1" > system< / span > (curl_command);
< span class = "pl-c" > /* parsing json and validating output */< / span >
root_value = < span class = "pl-c1" > json_parse_file< / span > (output_filename);
< span class = "pl-k" > if< / span > (< span class = "pl-c1" > json_value_get_type< / span > (root_value) != JSONArray) {
< span class = "pl-c1" > system< / span > (cleanup_command);
< span class = "pl-k" > return< / span > ;
}
< span class = "pl-c" > /* getting array from root value and printing commit info */< / span >
commits = < span class = "pl-c1" > json_value_get_array< / span > (root_value);
< span class = "pl-c1" > printf< / span > (< span class = "pl-s" > < span class = "pl-pds" > "< / span > < span class = "pl-c1" > %-10.10s< / span > < span class = "pl-c1" > %-10.10s< / span > < span class = "pl-c1" > %s< / span > < span class = "pl-cce" > \n< / span > < span class = "pl-pds" > "< / span > < / span > , < span class = "pl-s" > < span class = "pl-pds" > "< / span > Date< span class = "pl-pds" > "< / span > < / span > , < span class = "pl-s" > < span class = "pl-pds" > "< / span > SHA< span class = "pl-pds" > "< / span > < / span > , < span class = "pl-s" > < span class = "pl-pds" > "< / span > Author< span class = "pl-pds" > "< / span > < / span > );
< span class = "pl-k" > for< / span > (i = < span class = "pl-c1" > 0< / span > ; i < < span class = "pl-c1" > json_array_get_count< / span > (commits); i++) {
commit = < span class = "pl-c1" > json_array_get_object< / span > (commits, i);
< span class = "pl-c1" > printf< / span > (< span class = "pl-s" > < span class = "pl-pds" > "< / span > < span class = "pl-c1" > %.10s< / span > < span class = "pl-c1" > %.10s< / span > < span class = "pl-c1" > %s< / span > < span class = "pl-cce" > \n< / span > < span class = "pl-pds" > "< / span > < / span > ,
< span class = "pl-c1" > json_object_dotget_string< / span > (commit, < span class = "pl-s" > < span class = "pl-pds" > "< / span > commit.author.date< span class = "pl-pds" > "< / span > < / span > ),
< span class = "pl-c1" > json_object_get_string< / span > (commit, < span class = "pl-s" > < span class = "pl-pds" > "< / span > sha< span class = "pl-pds" > "< / span > < / span > ),
< span class = "pl-c1" > json_object_dotget_string< / span > (commit, < span class = "pl-s" > < span class = "pl-pds" > "< / span > commit.author.name< span class = "pl-pds" > "< / span > < / span > ));
}
< span class = "pl-c" > /* cleanup code */< / span >
< span class = "pl-c1" > json_value_free< / span > (root_value);
< span class = "pl-c1" > system< / span > (cleanup_command);
}
< / pre > < / div >
< p > Calling < code > print_commits_info("torvalds", "linux");< / code > prints: < / p >
< pre > < code > Date SHA Author
2012-10-15 dd8e8c4a2c David Rientjes
2012-10-15 3ce9e53e78 Michal Marek
2012-10-14 29bb4cc5e0 Randy Dunlap
2012-10-15 325adeb55e Ralf Baechle
2012-10-14 68687c842c Russell King
2012-10-14 ddffeb8c4d Linus Torvalds
...
< / code > < / pre >
< h3 >
< a id = "persistence" class = "anchor" href = "#persistence" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > Persistence< / h3 >
< p > In this example I'm using parson to save user information to a file and then load it and validate later.< / p >
< div class = "highlight highlight-source-c" > < pre > < span class = "pl-k" > void< / span > < span class = "pl-en" > persistence_example< / span > (< span class = "pl-k" > void< / span > ) {
JSON_Value *schema = < span class = "pl-c1" > json_parse_string< / span > (< span class = "pl-s" > < span class = "pl-pds" > "< / span > {< span class = "pl-cce" > \"< / span > name< span class = "pl-cce" > \"< / span > :< span class = "pl-cce" > \"\"< / span > }< span class = "pl-pds" > "< / span > < / span > );
JSON_Value *user_data = < span class = "pl-c1" > json_parse_file< / span > (< span class = "pl-s" > < span class = "pl-pds" > "< / span > user_data.json< span class = "pl-pds" > "< / span > < / span > );
< span class = "pl-k" > char< / span > buf[< span class = "pl-c1" > 256< / span > ];
< span class = "pl-k" > const< / span > < span class = "pl-k" > char< / span > *name = < span class = "pl-c1" > NULL< / span > ;
< span class = "pl-k" > if< / span > (user_data == < span class = "pl-c1" > NULL< / span > || < span class = "pl-c1" > json_validate< / span > (schema, user_data) != JSONSuccess) {
< span class = "pl-c1" > puts< / span > (< span class = "pl-s" > < span class = "pl-pds" > "< / span > Enter your name:< span class = "pl-pds" > "< / span > < / span > );
< span class = "pl-c1" > scanf< / span > (< span class = "pl-s" > < span class = "pl-pds" > "< / span > < span class = "pl-c1" > %s< / span > < span class = "pl-pds" > "< / span > < / span > , buf);
user_data = < span class = "pl-c1" > json_value_init_object< / span > ();
< span class = "pl-c1" > json_object_set_string< / span > (< span class = "pl-c1" > json_object< / span > (user_data), < span class = "pl-s" > < span class = "pl-pds" > "< / span > name< span class = "pl-pds" > "< / span > < / span > , buf);
< span class = "pl-c1" > json_serialize_to_file< / span > (user_data, < span class = "pl-s" > < span class = "pl-pds" > "< / span > user_data.json< span class = "pl-pds" > "< / span > < / span > );
}
name = < span class = "pl-c1" > json_object_get_string< / span > (< span class = "pl-c1" > json_object< / span > (user_data), < span class = "pl-s" > < span class = "pl-pds" > "< / span > name< span class = "pl-pds" > "< / span > < / span > );
< span class = "pl-c1" > printf< / span > (< span class = "pl-s" > < span class = "pl-pds" > "< / span > Hello, < span class = "pl-c1" > %s< / span > .< span class = "pl-pds" > "< / span > < / span > , name);
< span class = "pl-c1" > json_value_free< / span > (schema);
< span class = "pl-c1" > json_value_free< / span > (user_data);
< span class = "pl-k" > return< / span > ;
}< / pre > < / div >
< h3 >
< a id = "serialization" class = "anchor" href = "#serialization" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > Serialization< / h3 >
< p > Creating JSON values is very simple thanks to the dot notation.
Object hierarchy is automatically created when addressing specific fields.
In the following example I create a simple JSON value containing basic information about a person.< / p >
< div class = "highlight highlight-source-c" > < pre > < span class = "pl-k" > void< / span > < span class = "pl-en" > serialization_example< / span > (< span class = "pl-k" > void< / span > ) {
JSON_Value *root_value = < span class = "pl-c1" > json_value_init_object< / span > ();
JSON_Object *root_object = < span class = "pl-c1" > json_value_get_object< / span > (root_value);
< span class = "pl-k" > char< / span > *serialized_string = < span class = "pl-c1" > NULL< / span > ;
< span class = "pl-c1" > json_object_set_string< / span > (root_object, < span class = "pl-s" > < span class = "pl-pds" > "< / span > name< span class = "pl-pds" > "< / span > < / span > , < span class = "pl-s" > < span class = "pl-pds" > "< / span > John Smith< span class = "pl-pds" > "< / span > < / span > );
< span class = "pl-c1" > json_object_set_number< / span > (root_object, < span class = "pl-s" > < span class = "pl-pds" > "< / span > age< span class = "pl-pds" > "< / span > < / span > , < span class = "pl-c1" > 25< / span > );
< span class = "pl-c1" > json_object_dotset_string< / span > (root_object, < span class = "pl-s" > < span class = "pl-pds" > "< / span > address.city< span class = "pl-pds" > "< / span > < / span > , < span class = "pl-s" > < span class = "pl-pds" > "< / span > Cupertino< span class = "pl-pds" > "< / span > < / span > );
< span class = "pl-c1" > json_object_dotset_value< / span > (root_object, < span class = "pl-s" > < span class = "pl-pds" > "< / span > contact.emails< span class = "pl-pds" > "< / span > < / span > , < span class = "pl-c1" > json_parse_string< / span > (< span class = "pl-s" > < span class = "pl-pds" > "< / span > [< span class = "pl-cce" > \"< / span > email@example.com< span class = "pl-cce" > \"< / span > ,< span class = "pl-cce" > \"< / span > email2@example.com< span class = "pl-cce" > \"< / span > ]< span class = "pl-pds" > "< / span > < / span > ));
serialized_string = < span class = "pl-c1" > json_serialize_to_string_pretty< / span > (root_value);
< span class = "pl-c1" > puts< / span > (serialized_string);
< span class = "pl-c1" > json_free_serialized_string< / span > (serialized_string);
< span class = "pl-c1" > json_value_free< / span > (root_value);
}
< / pre > < / div >
< p > Output:< / p >
< pre > < code > {
"name": "John Smith",
"age": 25,
"address": {
"city": "Cupertino"
},
"contact": {
"emails": [
"email@example.com",
"email2@example.com"
]
}
}
< / code > < / pre >
< h2 >
< a id = "contributing" class = "anchor" href = "#contributing" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > Contributing< / h2 >
< p > I will always merge < em > working< / em > bug fixes. However, if you want to add something new to the API, please create an "issue" on github for this first so we can discuss if it should end up in the library before you start implementing it.
Remember to follow parson's code style and write appropriate tests.< / p >
< h2 >
< a id = "license" class = "anchor" href = "#license" aria-hidden = "true" > < span aria-hidden = "true" class = "octicon octicon-link" > < / span > < / a > License< / h2 >
< p > < a href = "http://opensource.org/licenses/mit-license.php" > The MIT License (MIT)< / a > < / p >
< / section >
< / div >
<!-- FOOTER -->
< div id = "footer_wrap" class = "outer" >
< footer class = "inner" >
< p class = "copyright" > parson maintained by < a href = "https://github.com/kgabis" > kgabis< / a > < / p >
< p > Published with < a href = "https://pages.github.com" > GitHub Pages< / a > < / p >
< / footer >
< / div >
< script type = "text/javascript" >
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
< / script >
< script type = "text/javascript" >
try {
var pageTracker = _gat._getTracker("UA-35563760-2");
pageTracker._trackPageview();
} catch(err) {}
< / script >
< / body >
< / html >
