source: trunk/packages/libyaml/doc/html/group__emitter.html @ 906

Last change on this file since 906 was 898, checked in by hartmans, 17 years ago

Add pyyaml and libyaml packages
backported from lenny.
There is discussion about how these should go in the repository; these are added in this form
in order to make forward progress.

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