diff options
Diffstat (limited to 'yajl-2.1.0/yajl__gen_8h.html')
| -rw-r--r-- | yajl-2.1.0/yajl__gen_8h.html | 629 |
1 files changed, 629 insertions, 0 deletions
diff --git a/yajl-2.1.0/yajl__gen_8h.html b/yajl-2.1.0/yajl__gen_8h.html new file mode 100644 index 0000000..6c46459 --- /dev/null +++ b/yajl-2.1.0/yajl__gen_8h.html @@ -0,0 +1,629 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>YAJL: yajl_gen.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">YAJL +  <span id="projectnumber">2.1.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li><a href="examples.html"><span>Examples</span></a></li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_da61e3e9a357748887e3ca8d7c5a0c16.html">api</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#typedef-members">Typedefs</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">yajl_gen.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <yajl/yajl_common.h></code><br/> +<code>#include <stddef.h></code><br/> +</div> +<p><a href="yajl__gen_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a497f7224309c1a0118f40c87e3fd3f65"><td class="memItemLeft" align="right" valign="top">typedef struct yajl_gen_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a></td></tr> +<tr class="separator:a497f7224309c1a0118f40c87e3fd3f65"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1060585da6ccce2bcf6d4820035e7b79"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a1060585da6ccce2bcf6d4820035e7b79">yajl_print_t</a> )(void *ctx, const char *str, size_t len)</td></tr> +<tr class="separator:a1060585da6ccce2bcf6d4820035e7b79"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:aff033c27f29817c1fc794a16197f63ca"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> { <br/> +  <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63caa457aa396721f15a7cf34508bf00e22d7">yajl_gen_status_ok</a> = 0, +<a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63caacc1716680733d72f34676755cdc4e876">yajl_gen_keys_must_be_strings</a>, +<a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63caa2db8bdfc64aab69fe95a33ba76d087e8">yajl_max_depth_exceeded</a>, +<a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63caa9ea74847e6d0e91bc7ee544e9851dc18">yajl_gen_in_error_state</a>, +<br/> +  <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63caa8274e47b1f4dd68841a67e56868f7bb4">yajl_gen_generation_complete</a>, +<a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63caa870e2d12c18f71a51697ddc4050a1262">yajl_gen_invalid_number</a>, +<a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63caae50f6bbe222a87d4d202933e5347b0d7">yajl_gen_no_buf</a>, +<a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63caa89e7434eadb637a4fd2ead0eea52ffa5">yajl_gen_invalid_string</a> +<br/> + }</td></tr> +<tr class="separator:aff033c27f29817c1fc794a16197f63ca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a57c29080044a7231ac0cf1fead4de4b0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0">yajl_gen_option</a> { <br/> +  <a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0a7ee1cbb5e028e6d0ac25890940918f16">yajl_gen_beautify</a> = 0x01, +<a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0a005636a2e073b474bfad337edf5890d4">yajl_gen_indent_string</a> = 0x02, +<a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0ac97419eedb3cce5f9af8319b31d5b42e">yajl_gen_print_callback</a> = 0x04, +<a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0acead1389b0381db8fe6f43ea25c0c3cc">yajl_gen_validate_utf8</a> = 0x08, +<br/> +  <a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0a26933b423381aacbbe035fef9204cd24">yajl_gen_escape_solidus</a> = 0x10 +<br/> + }</td></tr> +<tr class="separator:a57c29080044a7231ac0cf1fead4de4b0"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a1768fa9f58313c895d226419d8c59562"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a1768fa9f58313c895d226419d8c59562">yajl_gen_config</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> g, <a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0">yajl_gen_option</a> opt,...)</td></tr> +<tr class="separator:a1768fa9f58313c895d226419d8c59562"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a450ab80f9a562d2bd08fb103ba1b2c16"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a450ab80f9a562d2bd08fb103ba1b2c16">yajl_gen_alloc</a> (const <a class="el" href="structyajl__alloc__funcs.html">yajl_alloc_funcs</a> *allocFuncs)</td></tr> +<tr class="separator:a450ab80f9a562d2bd08fb103ba1b2c16"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9579c99fb77fb6f607db47de662adc9c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a9579c99fb77fb6f607db47de662adc9c">yajl_gen_free</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> handle)</td></tr> +<tr class="separator:a9579c99fb77fb6f607db47de662adc9c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a48064106605182f7591d62dea66c6008"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a48064106605182f7591d62dea66c6008">yajl_gen_integer</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand, long long int number)</td></tr> +<tr class="separator:a48064106605182f7591d62dea66c6008"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab588fa96fd582c3f592923fc0172f17c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#ab588fa96fd582c3f592923fc0172f17c">yajl_gen_double</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand, double number)</td></tr> +<tr class="separator:ab588fa96fd582c3f592923fc0172f17c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2be3838ee84e1bfb8580702c357afca8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a2be3838ee84e1bfb8580702c357afca8">yajl_gen_number</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand, const char *num, size_t len)</td></tr> +<tr class="separator:a2be3838ee84e1bfb8580702c357afca8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa9868194579f80d472131430f5f22228"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#aa9868194579f80d472131430f5f22228">yajl_gen_string</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand, const unsigned char *str, size_t len)</td></tr> +<tr class="separator:aa9868194579f80d472131430f5f22228"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a33ad490ddf9372c0d27d4c32b4b693d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a33ad490ddf9372c0d27d4c32b4b693d2">yajl_gen_null</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand)</td></tr> +<tr class="separator:a33ad490ddf9372c0d27d4c32b4b693d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b761fd105b212682de291ca70836f93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a9b761fd105b212682de291ca70836f93">yajl_gen_bool</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand, int boolean)</td></tr> +<tr class="separator:a9b761fd105b212682de291ca70836f93"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaaefb19b3b2c96b0d3d0bbf3bc4886b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#aaaefb19b3b2c96b0d3d0bbf3bc4886b2">yajl_gen_map_open</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand)</td></tr> +<tr class="separator:aaaefb19b3b2c96b0d3d0bbf3bc4886b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af75cd0ee728dbd835bbbefbcdc923dbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#af75cd0ee728dbd835bbbefbcdc923dbe">yajl_gen_map_close</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand)</td></tr> +<tr class="separator:af75cd0ee728dbd835bbbefbcdc923dbe"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a68f7bc4fbfe8015f590bc284d386bf44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a68f7bc4fbfe8015f590bc284d386bf44">yajl_gen_array_open</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand)</td></tr> +<tr class="separator:a68f7bc4fbfe8015f590bc284d386bf44"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae3ba7ebfbea5a27f30f4c6c62ddc493b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#ae3ba7ebfbea5a27f30f4c6c62ddc493b">yajl_gen_array_close</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand)</td></tr> +<tr class="separator:ae3ba7ebfbea5a27f30f4c6c62ddc493b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a62fdd1175a55da0c33b366a8aab925b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a62fdd1175a55da0c33b366a8aab925b0">yajl_gen_get_buf</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand, const unsigned char **buf, size_t *len)</td></tr> +<tr class="separator:a62fdd1175a55da0c33b366a8aab925b0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a50116818ab3c0f3116e3baff0db2f4ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a50116818ab3c0f3116e3baff0db2f4ef">yajl_gen_clear</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand)</td></tr> +<tr class="separator:a50116818ab3c0f3116e3baff0db2f4ef"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8c85c0341fd47caac8dc8edabcec4c8d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__gen_8h.html#a8c85c0341fd47caac8dc8edabcec4c8d">yajl_gen_reset</a> (<a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> hand, const char *sep)</td></tr> +<tr class="separator:a8c85c0341fd47caac8dc8edabcec4c8d"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Interface to YAJL's JSON generation facilities. </p> +</div><h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="a497f7224309c1a0118f40c87e3fd3f65"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct yajl_gen_t* <a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>an opaque handle to a generator </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a0">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a1060585da6ccce2bcf6d4820035e7b79"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef void(* yajl_print_t)(void *ctx, const char *str, size_t len)</td> + </tr> + </table> +</div><div class="memdoc"> +<p>a callback used for "printing" the results. </p> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a class="anchor" id="a57c29080044a7231ac0cf1fead4de4b0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0">yajl_gen_option</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>configuration parameters for the parser, these may be passed to <a class="el" href="yajl__gen_8h.html#a1768fa9f58313c895d226419d8c59562">yajl_gen_config()</a> along with option specific argument(s). In general, all configuration parameters default to <em>off</em>. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a57c29080044a7231ac0cf1fead4de4b0a7ee1cbb5e028e6d0ac25890940918f16"></a>yajl_gen_beautify</em> </td><td class="fielddoc"> +<p>generate indented (beautiful) output </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a57c29080044a7231ac0cf1fead4de4b0a005636a2e073b474bfad337edf5890d4"></a>yajl_gen_indent_string</em> </td><td class="fielddoc"> +<p>Set an indent string which is used when yajl_gen_beautify is enabled. Maybe something like \t or some number of spaces. The default is four spaces ' '. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a57c29080044a7231ac0cf1fead4de4b0ac97419eedb3cce5f9af8319b31d5b42e"></a>yajl_gen_print_callback</em> </td><td class="fielddoc"> +<p>Set a function and context argument that should be used to output generated json. the function should conform to the yajl_print_t prototype while the context argument is a void * of your choosing.</p> +<p>example: yajl_gen_config(g, yajl_gen_print_callback, myFunc, myVoidPtr); </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a57c29080044a7231ac0cf1fead4de4b0acead1389b0381db8fe6f43ea25c0c3cc"></a>yajl_gen_validate_utf8</em> </td><td class="fielddoc"> +<p>Normally the generator does not validate that strings you pass to it via <a class="el" href="yajl__gen_8h.html#aa9868194579f80d472131430f5f22228">yajl_gen_string()</a> are valid UTF8. Enabling this option will cause it to do so. </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a57c29080044a7231ac0cf1fead4de4b0a26933b423381aacbbe035fef9204cd24"></a>yajl_gen_escape_solidus</em> </td><td class="fielddoc"> +<p>the forward solidus (slash or '/' in human) is not required to be escaped in json text. By default, YAJL will not escape it in the iterest of saving bytes. Setting this flag will cause YAJL to always escape '/' in generated JSON strings. </p> +</td></tr> +</table> + +</div> +</div> +<a class="anchor" id="aff033c27f29817c1fc794a16197f63ca"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>generator status codes </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aff033c27f29817c1fc794a16197f63caa457aa396721f15a7cf34508bf00e22d7"></a>yajl_gen_status_ok</em> </td><td class="fielddoc"> +<p>no error </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="aff033c27f29817c1fc794a16197f63caacc1716680733d72f34676755cdc4e876"></a>yajl_gen_keys_must_be_strings</em> </td><td class="fielddoc"> +<p>at a point where a map key is generated, a function other than yajl_gen_string was called </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="aff033c27f29817c1fc794a16197f63caa2db8bdfc64aab69fe95a33ba76d087e8"></a>yajl_max_depth_exceeded</em> </td><td class="fielddoc"> +<p>YAJL's maximum generation depth was exceeded. see YAJL_MAX_DEPTH </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="aff033c27f29817c1fc794a16197f63caa9ea74847e6d0e91bc7ee544e9851dc18"></a>yajl_gen_in_error_state</em> </td><td class="fielddoc"> +<p>A generator function (yajl_gen_XXX) was called while in an error state </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="aff033c27f29817c1fc794a16197f63caa8274e47b1f4dd68841a67e56868f7bb4"></a>yajl_gen_generation_complete</em> </td><td class="fielddoc"> +<p>A complete JSON document has been generated </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="aff033c27f29817c1fc794a16197f63caa870e2d12c18f71a51697ddc4050a1262"></a>yajl_gen_invalid_number</em> </td><td class="fielddoc"> +<p>yajl_gen_double was passed an invalid floating point value (infinity or NaN). </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="aff033c27f29817c1fc794a16197f63caae50f6bbe222a87d4d202933e5347b0d7"></a>yajl_gen_no_buf</em> </td><td class="fielddoc"> +<p>A print callback was passed in, so there is no internal buffer to get from </p> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="aff033c27f29817c1fc794a16197f63caa89e7434eadb637a4fd2ead0eea52ffa5"></a>yajl_gen_invalid_string</em> </td><td class="fielddoc"> +<p>returned from <a class="el" href="yajl__gen_8h.html#aa9868194579f80d472131430f5f22228">yajl_gen_string()</a> when the yajl_gen_validate_utf8 option is enabled and an invalid was passed by client code. </p> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="a450ab80f9a562d2bd08fb103ba1b2c16"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> yajl_gen_alloc </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structyajl__alloc__funcs.html">yajl_alloc_funcs</a> * </td> + <td class="paramname"><em>allocFuncs</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>allocate a generator handle </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">allocFuncs</td><td>an optional pointer to a structure which allows the client to overide the memory allocation used by yajl. May be NULL, in which case malloc/free/realloc will be used.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>an allocated handle on success, NULL on failure (bad params) </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a10">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ae3ba7ebfbea5a27f30f4c6c62ddc493b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_array_close </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a8">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a68f7bc4fbfe8015f590bc284d386bf44"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_array_open </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a7">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a9b761fd105b212682de291ca70836f93"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_bool </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>boolean</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a2">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a50116818ab3c0f3116e3baff0db2f4ef"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> void yajl_gen_clear </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>clear yajl's output buffer, but maintain all internal generation state. This function will not "reset" the generator state, and is intended to enable incremental JSON outputing. </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a23">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a1768fa9f58313c895d226419d8c59562"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> int yajl_gen_config </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>g</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a57c29080044a7231ac0cf1fead4de4b0">yajl_gen_option</a> </td> + <td class="paramname"><em>opt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>allow the modification of generator options subsequent to handle allocation (via yajl_alloc) </p> +<dl class="section return"><dt>Returns</dt><dd>zero in case of errors, non-zero otherwise </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a11">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="ab588fa96fd582c3f592923fc0172f17c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_double </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double </td> + <td class="paramname"><em>number</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>generate a floating point number. number may not be infinity or NaN, as these have no representation in JSON. In these cases the generator will return 'yajl_gen_invalid_number' </p> + +</div> +</div> +<a class="anchor" id="a9579c99fb77fb6f607db47de662adc9c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> void yajl_gen_free </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>handle</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>free a generator handle </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a27">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a62fdd1175a55da0c33b366a8aab925b0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_get_buf </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const unsigned char ** </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t * </td> + <td class="paramname"><em>len</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>access the null terminated generator buffer. If incrementally outputing JSON, one should call yajl_gen_clear to clear the buffer. This allows stream generation. </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a22">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a48064106605182f7591d62dea66c6008"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_integer </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long long int </td> + <td class="paramname"><em>number</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="af75cd0ee728dbd835bbbefbcdc923dbe"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_map_close </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a6">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="aaaefb19b3b2c96b0d3d0bbf3bc4886b2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_map_open </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a5">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a33ad490ddf9372c0d27d4c32b4b693d2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_null </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a1">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a2be3838ee84e1bfb8580702c357afca8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_number </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>num</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>len</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a3">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a8c85c0341fd47caac8dc8edabcec4c8d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> void yajl_gen_reset </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>sep</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Reset the generator state. Allows a client to generate multiple json entities in a stream. The "sep" string will be inserted to separate the previously generated entity from the current, NULL means <em>no separation</em> of entites (clients beware, generating multiple JSON numbers, for instance, will result in inscrutable output) </p> + +</div> +</div> +<a class="anchor" id="aa9868194579f80d472131430f5f22228"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="yajl__common_8h.html#a112d9a9234313b4fa3d419c0723146c5">YAJL_API</a> <a class="el" href="yajl__gen_8h.html#aff033c27f29817c1fc794a16197f63ca">yajl_gen_status</a> yajl_gen_string </td> + <td>(</td> + <td class="paramtype"><a class="el" href="yajl__gen_8h.html#a497f7224309c1a0118f40c87e3fd3f65">yajl_gen</a> </td> + <td class="paramname"><em>hand</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const unsigned char * </td> + <td class="paramname"><em>str</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>len</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="reformatter_2json_reformat_8c-example.html#a4">reformatter/json_reformat.c</a>.</dd> +</dl> +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Tue Mar 18 2014 22:12:15 for YAJL by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> |