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