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