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