doc/html/group__emitter.html

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