doc/html/group__emitter.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.14"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>yaml: Emitter Definitions</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">yaml
  22    &#160;<span id="projectnumber">0.2.1</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.14 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Data Structures</a> &#124;
  44 <a href="#typedef-members">Typedefs</a> &#124;
  45 <a href="#enum-members">Enumerations</a> &#124;
  46 <a href="#func-members">Functions</a>  </div>
  47   <div class="headertitle">
  48 <div class="title">Emitter Definitions</div>  </div>
  49 </div><!--header-->
  50 <div class="contents">
  51 <table class="memberdecls">
  52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  53 Data Structures</h2></td></tr>
  54 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_s</a></td></tr>
  55 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The emitter structure.  <a href="structyaml__emitter__s.html#details">More...</a><br /></td></tr>
  56 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57 </table><table class="memberdecls">
  58 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  59 Typedefs</h2></td></tr>
  60 <tr class="memitem:ga1669659aacbe631ad406c78fce1f5379"><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a>(void *data, unsigned char *buffer, size_t size)</td></tr>
  61 <tr class="memdesc:ga1669659aacbe631ad406c78fce1f5379"><td class="mdescLeft">&#160;</td><td class="mdescRight">The prototype of a write handler.  <a href="#ga1669659aacbe631ad406c78fce1f5379">More...</a><br /></td></tr>
  62 <tr class="separator:ga1669659aacbe631ad406c78fce1f5379"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 <tr class="memitem:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga0889461fa3efe8eee881aef48a4ba6b2">yaml_emitter_state_t</a></td></tr>
  64 <tr class="memdesc:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The emitter states.  <a href="#ga0889461fa3efe8eee881aef48a4ba6b2">More...</a><br /></td></tr>
  65 <tr class="separator:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__emitter__s.html">yaml_emitter_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a></td></tr>
  67 <tr class="memdesc:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The emitter structure.  <a href="#ga4ce3e054f0016c49d9e8c36d359e710b">More...</a><br /></td></tr>
  68 <tr class="separator:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 </table><table class="memberdecls">
  70 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  71 Enumerations</h2></td></tr>
  72 <tr class="memitem:ga387b79da11c3941e43a56947263aa721"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a> { <br />
  73 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d">YAML_EMIT_STREAM_START_STATE</a>,
  74 <br />
  75 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae">YAML_EMIT_FIRST_DOCUMENT_START_STATE</a>,
  76 <br />
  77 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f">YAML_EMIT_DOCUMENT_START_STATE</a>,
  78 <br />
  79 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec">YAML_EMIT_DOCUMENT_CONTENT_STATE</a>,
  80 <br />
  81 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3">YAML_EMIT_DOCUMENT_END_STATE</a>,
  82 <br />
  83 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654">YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE</a>,
  84 <br />
  85 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767">YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE</a>,
  86 <br />
  87 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894">YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE</a>,
  88 <br />
  89 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626">YAML_EMIT_FLOW_MAPPING_KEY_STATE</a>,
  90 <br />
  91 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383">YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE</a>,
  92 <br />
  93 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e">YAML_EMIT_FLOW_MAPPING_VALUE_STATE</a>,
  94 <br />
  95 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d">YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE</a>,
  96 <br />
  97 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff">YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE</a>,
  98 <br />
  99 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e">YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE</a>,
 100 <br />
 101 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05">YAML_EMIT_BLOCK_MAPPING_KEY_STATE</a>,
 102 <br />
 103 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704">YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE</a>,
 104 <br />
 105 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564">YAML_EMIT_BLOCK_MAPPING_VALUE_STATE</a>,
 106 <br />
 107 &#160;&#160;<a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0">YAML_EMIT_END_STATE</a>
 108 <br />
 109  }</td></tr>
 110 <tr class="memdesc:ga387b79da11c3941e43a56947263aa721"><td class="mdescLeft">&#160;</td><td class="mdescRight">The emitter states.  <a href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">More...</a><br /></td></tr>
 111 <tr class="separator:ga387b79da11c3941e43a56947263aa721"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 </table><table class="memberdecls">
 113 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 114 Functions</h2></td></tr>
 115 <tr class="memitem:ga83649205374285802fc27aa293ecd111"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga83649205374285802fc27aa293ecd111">yaml_emitter_initialize</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
 116 <tr class="memdesc:ga83649205374285802fc27aa293ecd111"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize an emitter.  <a href="#ga83649205374285802fc27aa293ecd111">More...</a><br /></td></tr>
 117 <tr class="separator:ga83649205374285802fc27aa293ecd111"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 <tr class="memitem:gad705212f3a5150e3f00075fd90bc8c3d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gad705212f3a5150e3f00075fd90bc8c3d">yaml_emitter_delete</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
 119 <tr class="memdesc:gad705212f3a5150e3f00075fd90bc8c3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy an emitter.  <a href="#gad705212f3a5150e3f00075fd90bc8c3d">More...</a><br /></td></tr>
 120 <tr class="separator:gad705212f3a5150e3f00075fd90bc8c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <tr class="memitem:ga62725c0f616f634588374d1a4c0ed35a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga62725c0f616f634588374d1a4c0ed35a">yaml_emitter_set_output_string</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, unsigned char *output, size_t size, size_t *size_written)</td></tr>
 122 <tr class="memdesc:ga62725c0f616f634588374d1a4c0ed35a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a string output.  <a href="#ga62725c0f616f634588374d1a4c0ed35a">More...</a><br /></td></tr>
 123 <tr class="separator:ga62725c0f616f634588374d1a4c0ed35a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <tr class="memitem:gaf7610c61b303bde9c701024c10ece024"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gaf7610c61b303bde9c701024c10ece024">yaml_emitter_set_output_file</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, FILE *file)</td></tr>
 125 <tr class="memdesc:gaf7610c61b303bde9c701024c10ece024"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a file output.  <a href="#gaf7610c61b303bde9c701024c10ece024">More...</a><br /></td></tr>
 126 <tr class="separator:gaf7610c61b303bde9c701024c10ece024"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:gac85a6a212ed7b469fb426a3451d15922"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gac85a6a212ed7b469fb426a3451d15922">yaml_emitter_set_output</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> *handler, void *data)</td></tr>
 128 <tr class="memdesc:gac85a6a212ed7b469fb426a3451d15922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a generic output handler.  <a href="#gac85a6a212ed7b469fb426a3451d15922">More...</a><br /></td></tr>
 129 <tr class="separator:gac85a6a212ed7b469fb426a3451d15922"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 <tr class="memitem:gabc22888ec8bf942199acbf38f7a0b9bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gabc22888ec8bf942199acbf38f7a0b9bb">yaml_emitter_set_encoding</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr>
 131 <tr class="memdesc:gabc22888ec8bf942199acbf38f7a0b9bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the output encoding.  <a href="#gabc22888ec8bf942199acbf38f7a0b9bb">More...</a><br /></td></tr>
 132 <tr class="separator:gabc22888ec8bf942199acbf38f7a0b9bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:ga62713a8130e11d95cbefa95a2eb3ac4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga62713a8130e11d95cbefa95a2eb3ac4b">yaml_emitter_set_canonical</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int canonical)</td></tr>
 134 <tr class="memdesc:ga62713a8130e11d95cbefa95a2eb3ac4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set if the output should be in the "canonical" format as in the YAML specification.  <a href="#ga62713a8130e11d95cbefa95a2eb3ac4b">More...</a><br /></td></tr>
 135 <tr class="separator:ga62713a8130e11d95cbefa95a2eb3ac4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:ga07eca3c344053a9028b4a84291cdf4d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga07eca3c344053a9028b4a84291cdf4d7">yaml_emitter_set_indent</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int indent)</td></tr>
 137 <tr class="memdesc:ga07eca3c344053a9028b4a84291cdf4d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the intendation increment.  <a href="#ga07eca3c344053a9028b4a84291cdf4d7">More...</a><br /></td></tr>
 138 <tr class="separator:ga07eca3c344053a9028b4a84291cdf4d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:gaa91ae0fa8af5ab67e64567e08f4458c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gaa91ae0fa8af5ab67e64567e08f4458c2">yaml_emitter_set_width</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int width)</td></tr>
 140 <tr class="memdesc:gaa91ae0fa8af5ab67e64567e08f4458c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the preferred line width.  <a href="#gaa91ae0fa8af5ab67e64567e08f4458c2">More...</a><br /></td></tr>
 141 <tr class="separator:gaa91ae0fa8af5ab67e64567e08f4458c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:gaa59e7dcf24cb9b614c32af6c3e949fc3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gaa59e7dcf24cb9b614c32af6c3e949fc3">yaml_emitter_set_unicode</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int unicode)</td></tr>
 143 <tr class="memdesc:gaa59e7dcf24cb9b614c32af6c3e949fc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set if unescaped non-ASCII characters are allowed.  <a href="#gaa59e7dcf24cb9b614c32af6c3e949fc3">More...</a><br /></td></tr>
 144 <tr class="separator:gaa59e7dcf24cb9b614c32af6c3e949fc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:ga04b5494f0b8244eec359579c31d5e20c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga04b5494f0b8244eec359579c31d5e20c">yaml_emitter_set_break</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a> line_break)</td></tr>
 146 <tr class="memdesc:ga04b5494f0b8244eec359579c31d5e20c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the preferred line break.  <a href="#ga04b5494f0b8244eec359579c31d5e20c">More...</a><br /></td></tr>
 147 <tr class="separator:ga04b5494f0b8244eec359579c31d5e20c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:ga4d6c0f8e712797e2660e69479fdae433"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga4d6c0f8e712797e2660e69479fdae433">yaml_emitter_emit</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 149 <tr class="memdesc:ga4d6c0f8e712797e2660e69479fdae433"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit an event.  <a href="#ga4d6c0f8e712797e2660e69479fdae433">More...</a><br /></td></tr>
 150 <tr class="separator:ga4d6c0f8e712797e2660e69479fdae433"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:gae323c34e378040106f24c7b5ab834b16"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gae323c34e378040106f24c7b5ab834b16">yaml_emitter_open</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
 152 <tr class="memdesc:gae323c34e378040106f24c7b5ab834b16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a YAML stream.  <a href="#gae323c34e378040106f24c7b5ab834b16">More...</a><br /></td></tr>
 153 <tr class="separator:gae323c34e378040106f24c7b5ab834b16"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:gaa91442864679280985df14b2d96b8c42"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gaa91442864679280985df14b2d96b8c42">yaml_emitter_close</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
 155 <tr class="memdesc:gaa91442864679280985df14b2d96b8c42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish a YAML stream.  <a href="#gaa91442864679280985df14b2d96b8c42">More...</a><br /></td></tr>
 156 <tr class="separator:gaa91442864679280985df14b2d96b8c42"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:ga5f0306abe9bff373b5bc339913b3769c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga5f0306abe9bff373b5bc339913b3769c">yaml_emitter_dump</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr>
 158 <tr class="memdesc:ga5f0306abe9bff373b5bc339913b3769c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit a YAML document.  <a href="#ga5f0306abe9bff373b5bc339913b3769c">More...</a><br /></td></tr>
 159 <tr class="separator:ga5f0306abe9bff373b5bc339913b3769c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:gacaf24456e2bf85bc5654cbd7d828055f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gacaf24456e2bf85bc5654cbd7d828055f">yaml_emitter_flush</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
 161 <tr class="memdesc:gacaf24456e2bf85bc5654cbd7d828055f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush the accumulated characters to the output.  <a href="#gacaf24456e2bf85bc5654cbd7d828055f">More...</a><br /></td></tr>
 162 <tr class="separator:gacaf24456e2bf85bc5654cbd7d828055f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 </table>
 164 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 165 <h2 class="groupheader">Typedef Documentation</h2>
 166 <a id="ga1669659aacbe631ad406c78fce1f5379"></a>
 167 <h2 class="memtitle"><span class="permalink"><a href="#ga1669659aacbe631ad406c78fce1f5379">&#9670;&nbsp;</a></span>yaml_write_handler_t</h2>
 168
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">typedef int yaml_write_handler_t(void *data, unsigned char *buffer, size_t size)</td>
 174         </tr>
 175       </table>
 176 </div><div class="memdoc">
 177
 178 <p>The prototype of a write handler. </p>
 179 <p>The write handler is called when the emitter needs to flush the accumulated characters to the output. The handler should write <em>size</em> bytes of the <em>buffer</em> to the output.</p>
 180 <dl class="params"><dt>Parameters</dt><dd>
 181   <table class="params">
 182     <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>A pointer to an application data specified by <a class="el" href="group__emitter.html#gac85a6a212ed7b469fb426a3451d15922" title="Set a generic output handler. ">yaml_emitter_set_output()</a>. </td></tr>
 183     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The buffer with bytes to be written. </td></tr>
 184     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the buffer.</td></tr>
 185   </table>
 186   </dd>
 187 </dl>
 188 <dl class="section return"><dt>Returns</dt><dd>On success, the handler should return <code>1</code>. If the handler failed, the returned value should be <code>0</code>. </dd></dl>
 189
 190 </div>
 191 </div>
 192 <a id="ga0889461fa3efe8eee881aef48a4ba6b2"></a>
 193 <h2 class="memtitle"><span class="permalink"><a href="#ga0889461fa3efe8eee881aef48a4ba6b2">&#9670;&nbsp;</a></span>yaml_emitter_state_t</h2>
 194
 195 <div class="memitem">
 196 <div class="memproto">
 197       <table class="memname">
 198         <tr>
 199           <td class="memname">typedef enum <a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a>  <a class="el" href="group__emitter.html#ga0889461fa3efe8eee881aef48a4ba6b2">yaml_emitter_state_t</a></td>
 200         </tr>
 201       </table>
 202 </div><div class="memdoc">
 203
 204 <p>The emitter states. </p>
 205
 206 </div>
 207 </div>
 208 <a id="ga4ce3e054f0016c49d9e8c36d359e710b"></a>
 209 <h2 class="memtitle"><span class="permalink"><a href="#ga4ce3e054f0016c49d9e8c36d359e710b">&#9670;&nbsp;</a></span>yaml_emitter_t</h2>
 210
 211 <div class="memitem">
 212 <div class="memproto">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname">typedef struct <a class="el" href="structyaml__emitter__s.html">yaml_emitter_s</a>  <a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a></td>
 216         </tr>
 217       </table>
 218 </div><div class="memdoc">
 219
 220 <p>The emitter structure. </p>
 221 <p>All members are internal. Manage the structure using the <code>yaml_emitter_</code> family of functions. </p>
 222
 223 </div>
 224 </div>
 225 <h2 class="groupheader">Enumeration Type Documentation</h2>
 226 <a id="ga387b79da11c3941e43a56947263aa721"></a>
 227 <h2 class="memtitle"><span class="permalink"><a href="#ga387b79da11c3941e43a56947263aa721">&#9670;&nbsp;</a></span>yaml_emitter_state_e</h2>
 228
 229 <div class="memitem">
 230 <div class="memproto">
 231       <table class="memname">
 232         <tr>
 233           <td class="memname">enum <a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a></td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237
 238 <p>The emitter states. </p>
 239 <table class="fieldtable">
 240 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d"></a>YAML_EMIT_STREAM_START_STATE&#160;</td><td class="fielddoc"><p>Expect STREAM-START. </p>
 241 </td></tr>
 242 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae"></a>YAML_EMIT_FIRST_DOCUMENT_START_STATE&#160;</td><td class="fielddoc"><p>Expect the first DOCUMENT-START or STREAM-END. </p>
 243 </td></tr>
 244 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f"></a>YAML_EMIT_DOCUMENT_START_STATE&#160;</td><td class="fielddoc"><p>Expect DOCUMENT-START or STREAM-END. </p>
 245 </td></tr>
 246 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec"></a>YAML_EMIT_DOCUMENT_CONTENT_STATE&#160;</td><td class="fielddoc"><p>Expect the content of a document. </p>
 247 </td></tr>
 248 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3"></a>YAML_EMIT_DOCUMENT_END_STATE&#160;</td><td class="fielddoc"><p>Expect DOCUMENT-END. </p>
 249 </td></tr>
 250 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654"></a>YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE&#160;</td><td class="fielddoc"><p>Expect the first item of a flow sequence. </p>
 251 </td></tr>
 252 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767"></a>YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE&#160;</td><td class="fielddoc"><p>Expect an item of a flow sequence. </p>
 253 </td></tr>
 254 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894"></a>YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE&#160;</td><td class="fielddoc"><p>Expect the first key of a flow mapping. </p>
 255 </td></tr>
 256 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626"></a>YAML_EMIT_FLOW_MAPPING_KEY_STATE&#160;</td><td class="fielddoc"><p>Expect a key of a flow mapping. </p>
 257 </td></tr>
 258 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383"></a>YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE&#160;</td><td class="fielddoc"><p>Expect a value for a simple key of a flow mapping. </p>
 259 </td></tr>
 260 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e"></a>YAML_EMIT_FLOW_MAPPING_VALUE_STATE&#160;</td><td class="fielddoc"><p>Expect a value of a flow mapping. </p>
 261 </td></tr>
 262 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d"></a>YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE&#160;</td><td class="fielddoc"><p>Expect the first item of a block sequence. </p>
 263 </td></tr>
 264 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff"></a>YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE&#160;</td><td class="fielddoc"><p>Expect an item of a block sequence. </p>
 265 </td></tr>
 266 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e"></a>YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE&#160;</td><td class="fielddoc"><p>Expect the first key of a block mapping. </p>
 267 </td></tr>
 268 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05"></a>YAML_EMIT_BLOCK_MAPPING_KEY_STATE&#160;</td><td class="fielddoc"><p>Expect the key of a block mapping. </p>
 269 </td></tr>
 270 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704"></a>YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE&#160;</td><td class="fielddoc"><p>Expect a value for a simple key of a block mapping. </p>
 271 </td></tr>
 272 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564"></a>YAML_EMIT_BLOCK_MAPPING_VALUE_STATE&#160;</td><td class="fielddoc"><p>Expect a value of a block mapping. </p>
 273 </td></tr>
 274 <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0"></a>YAML_EMIT_END_STATE&#160;</td><td class="fielddoc"><p>Expect nothing. </p>
 275 </td></tr>
 276 </table>
 277
 278 </div>
 279 </div>
 280 <h2 class="groupheader">Function Documentation</h2>
 281 <a id="ga83649205374285802fc27aa293ecd111"></a>
 282 <h2 class="memtitle"><span class="permalink"><a href="#ga83649205374285802fc27aa293ecd111">&#9670;&nbsp;</a></span>yaml_emitter_initialize()</h2>
 283
 284 <div class="memitem">
 285 <div class="memproto">
 286       <table class="memname">
 287         <tr>
 288           <td class="memname">int yaml_emitter_initialize </td>
 289           <td>(</td>
 290           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 291           <td class="paramname"><em>emitter</em></td><td>)</td>
 292           <td></td>
 293         </tr>
 294       </table>
 295 </div><div class="memdoc">
 296
 297 <p>Initialize an emitter. </p>
 298 <p>This function creates a new emitter object. An application is responsible for destroying the object using the <a class="el" href="group__emitter.html#gad705212f3a5150e3f00075fd90bc8c3d" title="Destroy an emitter. ">yaml_emitter_delete()</a> function.</p>
 299 <dl class="params"><dt>Parameters</dt><dd>
 300   <table class="params">
 301     <tr><td class="paramdir">[out]</td><td class="paramname">emitter</td><td>An empty parser object.</td></tr>
 302   </table>
 303   </dd>
 304 </dl>
 305 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 306
 307 </div>
 308 </div>
 309 <a id="gad705212f3a5150e3f00075fd90bc8c3d"></a>
 310 <h2 class="memtitle"><span class="permalink"><a href="#gad705212f3a5150e3f00075fd90bc8c3d">&#9670;&nbsp;</a></span>yaml_emitter_delete()</h2>
 311
 312 <div class="memitem">
 313 <div class="memproto">
 314       <table class="memname">
 315         <tr>
 316           <td class="memname">void yaml_emitter_delete </td>
 317           <td>(</td>
 318           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 319           <td class="paramname"><em>emitter</em></td><td>)</td>
 320           <td></td>
 321         </tr>
 322       </table>
 323 </div><div class="memdoc">
 324
 325 <p>Destroy an emitter. </p>
 326 <dl class="params"><dt>Parameters</dt><dd>
 327   <table class="params">
 328     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 329   </table>
 330   </dd>
 331 </dl>
 332
 333 </div>
 334 </div>
 335 <a id="ga62725c0f616f634588374d1a4c0ed35a"></a>
 336 <h2 class="memtitle"><span class="permalink"><a href="#ga62725c0f616f634588374d1a4c0ed35a">&#9670;&nbsp;</a></span>yaml_emitter_set_output_string()</h2>
 337
 338 <div class="memitem">
 339 <div class="memproto">
 340       <table class="memname">
 341         <tr>
 342           <td class="memname">void yaml_emitter_set_output_string </td>
 343           <td>(</td>
 344           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 345           <td class="paramname"><em>emitter</em>, </td>
 346         </tr>
 347         <tr>
 348           <td class="paramkey"></td>
 349           <td></td>
 350           <td class="paramtype">unsigned char *&#160;</td>
 351           <td class="paramname"><em>output</em>, </td>
 352         </tr>
 353         <tr>
 354           <td class="paramkey"></td>
 355           <td></td>
 356           <td class="paramtype">size_t&#160;</td>
 357           <td class="paramname"><em>size</em>, </td>
 358         </tr>
 359         <tr>
 360           <td class="paramkey"></td>
 361           <td></td>
 362           <td class="paramtype">size_t *&#160;</td>
 363           <td class="paramname"><em>size_written</em>&#160;</td>
 364         </tr>
 365         <tr>
 366           <td></td>
 367           <td>)</td>
 368           <td></td><td></td>
 369         </tr>
 370       </table>
 371 </div><div class="memdoc">
 372
 373 <p>Set a string output. </p>
 374 <p>The emitter will write the output characters to the <em>output</em> buffer of the size <em>size</em>. The emitter will set <em>size_written</em> to the number of written bytes. If the buffer is smaller than required, the emitter produces the YAML_WRITE_ERROR error.</p>
 375 <dl class="params"><dt>Parameters</dt><dd>
 376   <table class="params">
 377     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 378     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>An output buffer. </td></tr>
 379     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The buffer size. </td></tr>
 380     <tr><td class="paramdir">[in]</td><td class="paramname">size_written</td><td>The pointer to save the number of written bytes. </td></tr>
 381   </table>
 382   </dd>
 383 </dl>
 384
 385 </div>
 386 </div>
 387 <a id="gaf7610c61b303bde9c701024c10ece024"></a>
 388 <h2 class="memtitle"><span class="permalink"><a href="#gaf7610c61b303bde9c701024c10ece024">&#9670;&nbsp;</a></span>yaml_emitter_set_output_file()</h2>
 389
 390 <div class="memitem">
 391 <div class="memproto">
 392       <table class="memname">
 393         <tr>
 394           <td class="memname">void yaml_emitter_set_output_file </td>
 395           <td>(</td>
 396           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 397           <td class="paramname"><em>emitter</em>, </td>
 398         </tr>
 399         <tr>
 400           <td class="paramkey"></td>
 401           <td></td>
 402           <td class="paramtype">FILE *&#160;</td>
 403           <td class="paramname"><em>file</em>&#160;</td>
 404         </tr>
 405         <tr>
 406           <td></td>
 407           <td>)</td>
 408           <td></td><td></td>
 409         </tr>
 410       </table>
 411 </div><div class="memdoc">
 412
 413 <p>Set a file output. </p>
 414 <p><em>file</em> should be a file object open for writing. The application is responsible for closing the <em>file</em>.</p>
 415 <dl class="params"><dt>Parameters</dt><dd>
 416   <table class="params">
 417     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 418     <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>An open file. </td></tr>
 419   </table>
 420   </dd>
 421 </dl>
 422
 423 </div>
 424 </div>
 425 <a id="gac85a6a212ed7b469fb426a3451d15922"></a>
 426 <h2 class="memtitle"><span class="permalink"><a href="#gac85a6a212ed7b469fb426a3451d15922">&#9670;&nbsp;</a></span>yaml_emitter_set_output()</h2>
 427
 428 <div class="memitem">
 429 <div class="memproto">
 430       <table class="memname">
 431         <tr>
 432           <td class="memname">void yaml_emitter_set_output </td>
 433           <td>(</td>
 434           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 435           <td class="paramname"><em>emitter</em>, </td>
 436         </tr>
 437         <tr>
 438           <td class="paramkey"></td>
 439           <td></td>
 440           <td class="paramtype"><a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> *&#160;</td>
 441           <td class="paramname"><em>handler</em>, </td>
 442         </tr>
 443         <tr>
 444           <td class="paramkey"></td>
 445           <td></td>
 446           <td class="paramtype">void *&#160;</td>
 447           <td class="paramname"><em>data</em>&#160;</td>
 448         </tr>
 449         <tr>
 450           <td></td>
 451           <td>)</td>
 452           <td></td><td></td>
 453         </tr>
 454       </table>
 455 </div><div class="memdoc">
 456
 457 <p>Set a generic output handler. </p>
 458 <dl class="params"><dt>Parameters</dt><dd>
 459   <table class="params">
 460     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 461     <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>A write handler. </td></tr>
 462     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Any application data for passing to the write handler. </td></tr>
 463   </table>
 464   </dd>
 465 </dl>
 466
 467 </div>
 468 </div>
 469 <a id="gabc22888ec8bf942199acbf38f7a0b9bb"></a>
 470 <h2 class="memtitle"><span class="permalink"><a href="#gabc22888ec8bf942199acbf38f7a0b9bb">&#9670;&nbsp;</a></span>yaml_emitter_set_encoding()</h2>
 471
 472 <div class="memitem">
 473 <div class="memproto">
 474       <table class="memname">
 475         <tr>
 476           <td class="memname">void yaml_emitter_set_encoding </td>
 477           <td>(</td>
 478           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 479           <td class="paramname"><em>emitter</em>, </td>
 480         </tr>
 481         <tr>
 482           <td class="paramkey"></td>
 483           <td></td>
 484           <td class="paramtype"><a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a>&#160;</td>
 485           <td class="paramname"><em>encoding</em>&#160;</td>
 486         </tr>
 487         <tr>
 488           <td></td>
 489           <td>)</td>
 490           <td></td><td></td>
 491         </tr>
 492       </table>
 493 </div><div class="memdoc">
 494
 495 <p>Set the output encoding. </p>
 496 <dl class="params"><dt>Parameters</dt><dd>
 497   <table class="params">
 498     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 499     <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The output encoding. </td></tr>
 500   </table>
 501   </dd>
 502 </dl>
 503
 504 </div>
 505 </div>
 506 <a id="ga62713a8130e11d95cbefa95a2eb3ac4b"></a>
 507 <h2 class="memtitle"><span class="permalink"><a href="#ga62713a8130e11d95cbefa95a2eb3ac4b">&#9670;&nbsp;</a></span>yaml_emitter_set_canonical()</h2>
 508
 509 <div class="memitem">
 510 <div class="memproto">
 511       <table class="memname">
 512         <tr>
 513           <td class="memname">void yaml_emitter_set_canonical </td>
 514           <td>(</td>
 515           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 516           <td class="paramname"><em>emitter</em>, </td>
 517         </tr>
 518         <tr>
 519           <td class="paramkey"></td>
 520           <td></td>
 521           <td class="paramtype">int&#160;</td>
 522           <td class="paramname"><em>canonical</em>&#160;</td>
 523         </tr>
 524         <tr>
 525           <td></td>
 526           <td>)</td>
 527           <td></td><td></td>
 528         </tr>
 529       </table>
 530 </div><div class="memdoc">
 531
 532 <p>Set if the output should be in the "canonical" format as in the YAML specification. </p>
 533 <dl class="params"><dt>Parameters</dt><dd>
 534   <table class="params">
 535     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 536     <tr><td class="paramdir">[in]</td><td class="paramname">canonical</td><td>If the output is canonical. </td></tr>
 537   </table>
 538   </dd>
 539 </dl>
 540
 541 </div>
 542 </div>
 543 <a id="ga07eca3c344053a9028b4a84291cdf4d7"></a>
 544 <h2 class="memtitle"><span class="permalink"><a href="#ga07eca3c344053a9028b4a84291cdf4d7">&#9670;&nbsp;</a></span>yaml_emitter_set_indent()</h2>
 545
 546 <div class="memitem">
 547 <div class="memproto">
 548       <table class="memname">
 549         <tr>
 550           <td class="memname">void yaml_emitter_set_indent </td>
 551           <td>(</td>
 552           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 553           <td class="paramname"><em>emitter</em>, </td>
 554         </tr>
 555         <tr>
 556           <td class="paramkey"></td>
 557           <td></td>
 558           <td class="paramtype">int&#160;</td>
 559           <td class="paramname"><em>indent</em>&#160;</td>
 560         </tr>
 561         <tr>
 562           <td></td>
 563           <td>)</td>
 564           <td></td><td></td>
 565         </tr>
 566       </table>
 567 </div><div class="memdoc">
 568
 569 <p>Set the intendation increment. </p>
 570 <dl class="params"><dt>Parameters</dt><dd>
 571   <table class="params">
 572     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 573     <tr><td class="paramdir">[in]</td><td class="paramname">indent</td><td>The indentation increment (1 &lt; . &lt; 10). </td></tr>
 574   </table>
 575   </dd>
 576 </dl>
 577
 578 </div>
 579 </div>
 580 <a id="gaa91ae0fa8af5ab67e64567e08f4458c2"></a>
 581 <h2 class="memtitle"><span class="permalink"><a href="#gaa91ae0fa8af5ab67e64567e08f4458c2">&#9670;&nbsp;</a></span>yaml_emitter_set_width()</h2>
 582
 583 <div class="memitem">
 584 <div class="memproto">
 585       <table class="memname">
 586         <tr>
 587           <td class="memname">void yaml_emitter_set_width </td>
 588           <td>(</td>
 589           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 590           <td class="paramname"><em>emitter</em>, </td>
 591         </tr>
 592         <tr>
 593           <td class="paramkey"></td>
 594           <td></td>
 595           <td class="paramtype">int&#160;</td>
 596           <td class="paramname"><em>width</em>&#160;</td>
 597         </tr>
 598         <tr>
 599           <td></td>
 600           <td>)</td>
 601           <td></td><td></td>
 602         </tr>
 603       </table>
 604 </div><div class="memdoc">
 605
 606 <p>Set the preferred line width. </p>
 607 <p><code>-1</code> means unlimited.</p>
 608 <dl class="params"><dt>Parameters</dt><dd>
 609   <table class="params">
 610     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 611     <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The preferred line width. </td></tr>
 612   </table>
 613   </dd>
 614 </dl>
 615
 616 </div>
 617 </div>
 618 <a id="gaa59e7dcf24cb9b614c32af6c3e949fc3"></a>
 619 <h2 class="memtitle"><span class="permalink"><a href="#gaa59e7dcf24cb9b614c32af6c3e949fc3">&#9670;&nbsp;</a></span>yaml_emitter_set_unicode()</h2>
 620
 621 <div class="memitem">
 622 <div class="memproto">
 623       <table class="memname">
 624         <tr>
 625           <td class="memname">void yaml_emitter_set_unicode </td>
 626           <td>(</td>
 627           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 628           <td class="paramname"><em>emitter</em>, </td>
 629         </tr>
 630         <tr>
 631           <td class="paramkey"></td>
 632           <td></td>
 633           <td class="paramtype">int&#160;</td>
 634           <td class="paramname"><em>unicode</em>&#160;</td>
 635         </tr>
 636         <tr>
 637           <td></td>
 638           <td>)</td>
 639           <td></td><td></td>
 640         </tr>
 641       </table>
 642 </div><div class="memdoc">
 643
 644 <p>Set if unescaped non-ASCII characters are allowed. </p>
 645 <dl class="params"><dt>Parameters</dt><dd>
 646   <table class="params">
 647     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 648     <tr><td class="paramdir">[in]</td><td class="paramname">unicode</td><td>If unescaped Unicode characters are allowed. </td></tr>
 649   </table>
 650   </dd>
 651 </dl>
 652
 653 </div>
 654 </div>
 655 <a id="ga04b5494f0b8244eec359579c31d5e20c"></a>
 656 <h2 class="memtitle"><span class="permalink"><a href="#ga04b5494f0b8244eec359579c31d5e20c">&#9670;&nbsp;</a></span>yaml_emitter_set_break()</h2>
 657
 658 <div class="memitem">
 659 <div class="memproto">
 660       <table class="memname">
 661         <tr>
 662           <td class="memname">void yaml_emitter_set_break </td>
 663           <td>(</td>
 664           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 665           <td class="paramname"><em>emitter</em>, </td>
 666         </tr>
 667         <tr>
 668           <td class="paramkey"></td>
 669           <td></td>
 670           <td class="paramtype"><a class="el" href="group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a>&#160;</td>
 671           <td class="paramname"><em>line_break</em>&#160;</td>
 672         </tr>
 673         <tr>
 674           <td></td>
 675           <td>)</td>
 676           <td></td><td></td>
 677         </tr>
 678       </table>
 679 </div><div class="memdoc">
 680
 681 <p>Set the preferred line break. </p>
 682 <dl class="params"><dt>Parameters</dt><dd>
 683   <table class="params">
 684     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 685     <tr><td class="paramdir">[in]</td><td class="paramname">line_break</td><td>The preferred line break. </td></tr>
 686   </table>
 687   </dd>
 688 </dl>
 689
 690 </div>
 691 </div>
 692 <a id="ga4d6c0f8e712797e2660e69479fdae433"></a>
 693 <h2 class="memtitle"><span class="permalink"><a href="#ga4d6c0f8e712797e2660e69479fdae433">&#9670;&nbsp;</a></span>yaml_emitter_emit()</h2>
 694
 695 <div class="memitem">
 696 <div class="memproto">
 697       <table class="memname">
 698         <tr>
 699           <td class="memname">int yaml_emitter_emit </td>
 700           <td>(</td>
 701           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 702           <td class="paramname"><em>emitter</em>, </td>
 703         </tr>
 704         <tr>
 705           <td class="paramkey"></td>
 706           <td></td>
 707           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 708           <td class="paramname"><em>event</em>&#160;</td>
 709         </tr>
 710         <tr>
 711           <td></td>
 712           <td>)</td>
 713           <td></td><td></td>
 714         </tr>
 715       </table>
 716 </div><div class="memdoc">
 717
 718 <p>Emit an event. </p>
 719 <p>The event object may be generated using the <a class="el" href="group__parser.html#ga559312fb137533d8b7e07f224fe0ec8f" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a> function. The emitter takes the responsibility for the event object and destroys its content after it is emitted. The event object is destroyed even if the function fails.</p>
 720 <dl class="params"><dt>Parameters</dt><dd>
 721   <table class="params">
 722     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 723     <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>An event object.</td></tr>
 724   </table>
 725   </dd>
 726 </dl>
 727 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 728
 729 </div>
 730 </div>
 731 <a id="gae323c34e378040106f24c7b5ab834b16"></a>
 732 <h2 class="memtitle"><span class="permalink"><a href="#gae323c34e378040106f24c7b5ab834b16">&#9670;&nbsp;</a></span>yaml_emitter_open()</h2>
 733
 734 <div class="memitem">
 735 <div class="memproto">
 736       <table class="memname">
 737         <tr>
 738           <td class="memname">int yaml_emitter_open </td>
 739           <td>(</td>
 740           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 741           <td class="paramname"><em>emitter</em></td><td>)</td>
 742           <td></td>
 743         </tr>
 744       </table>
 745 </div><div class="memdoc">
 746
 747 <p>Start a YAML stream. </p>
 748 <p>This function should be used before <a class="el" href="group__emitter.html#ga5f0306abe9bff373b5bc339913b3769c" title="Emit a YAML document. ">yaml_emitter_dump()</a> is called.</p>
 749 <dl class="params"><dt>Parameters</dt><dd>
 750   <table class="params">
 751     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr>
 752   </table>
 753   </dd>
 754 </dl>
 755 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 756
 757 </div>
 758 </div>
 759 <a id="gaa91442864679280985df14b2d96b8c42"></a>
 760 <h2 class="memtitle"><span class="permalink"><a href="#gaa91442864679280985df14b2d96b8c42">&#9670;&nbsp;</a></span>yaml_emitter_close()</h2>
 761
 762 <div class="memitem">
 763 <div class="memproto">
 764       <table class="memname">
 765         <tr>
 766           <td class="memname">int yaml_emitter_close </td>
 767           <td>(</td>
 768           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 769           <td class="paramname"><em>emitter</em></td><td>)</td>
 770           <td></td>
 771         </tr>
 772       </table>
 773 </div><div class="memdoc">
 774
 775 <p>Finish a YAML stream. </p>
 776 <p>This function should be used after <a class="el" href="group__emitter.html#ga5f0306abe9bff373b5bc339913b3769c" title="Emit a YAML document. ">yaml_emitter_dump()</a> is called.</p>
 777 <dl class="params"><dt>Parameters</dt><dd>
 778   <table class="params">
 779     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr>
 780   </table>
 781   </dd>
 782 </dl>
 783 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 784
 785 </div>
 786 </div>
 787 <a id="ga5f0306abe9bff373b5bc339913b3769c"></a>
 788 <h2 class="memtitle"><span class="permalink"><a href="#ga5f0306abe9bff373b5bc339913b3769c">&#9670;&nbsp;</a></span>yaml_emitter_dump()</h2>
 789
 790 <div class="memitem">
 791 <div class="memproto">
 792       <table class="memname">
 793         <tr>
 794           <td class="memname">int yaml_emitter_dump </td>
 795           <td>(</td>
 796           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 797           <td class="paramname"><em>emitter</em>, </td>
 798         </tr>
 799         <tr>
 800           <td class="paramkey"></td>
 801           <td></td>
 802           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 803           <td class="paramname"><em>document</em>&#160;</td>
 804         </tr>
 805         <tr>
 806           <td></td>
 807           <td>)</td>
 808           <td></td><td></td>
 809         </tr>
 810       </table>
 811 </div><div class="memdoc">
 812
 813 <p>Emit a YAML document. </p>
 814 <p>The documen object may be generated using the <a class="el" href="group__parser.html#ga9ef7d6e9494766b5880c389bc431d138" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a> function or the <a class="el" href="group__nodes.html#ga62a485c96f3b7962436a0da5e6f3cc89" title="Create a YAML document. ">yaml_document_initialize()</a> function. The emitter takes the responsibility for the document object and destroys its content after it is emitted. The document object is destroyed even if the function fails.</p>
 815 <dl class="params"><dt>Parameters</dt><dd>
 816   <table class="params">
 817     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
 818     <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object.</td></tr>
 819   </table>
 820   </dd>
 821 </dl>
 822 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 823
 824 </div>
 825 </div>
 826 <a id="gacaf24456e2bf85bc5654cbd7d828055f"></a>
 827 <h2 class="memtitle"><span class="permalink"><a href="#gacaf24456e2bf85bc5654cbd7d828055f">&#9670;&nbsp;</a></span>yaml_emitter_flush()</h2>
 828
 829 <div class="memitem">
 830 <div class="memproto">
 831       <table class="memname">
 832         <tr>
 833           <td class="memname">int yaml_emitter_flush </td>
 834           <td>(</td>
 835           <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *&#160;</td>
 836           <td class="paramname"><em>emitter</em></td><td>)</td>
 837           <td></td>
 838         </tr>
 839       </table>
 840 </div><div class="memdoc">
 841
 842 <p>Flush the accumulated characters to the output. </p>
 843 <dl class="params"><dt>Parameters</dt><dd>
 844   <table class="params">
 845     <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr>
 846   </table>
 847   </dd>
 848 </dl>
 849 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 850
 851 </div>
 852 </div>
 853 </div><!-- contents -->
 854 <!-- start footer part -->
 855 <hr class="footer"/><address class="footer"><small>
 856 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 857 <img class="footer" src="doxygen.png" alt="doxygen"/>
 858 </a> 1.8.14
 859 </small></address>
 860 </body>
 861 </html>