← Back to branch summary

~ubuntu-branches/ubuntu/saucy/libyaml/saucy-security

« back to all changes in this revision

Viewing changes to doc/html/group__emitter.html

  • Committer: Bazaar Package Importer
  • Author(s): Anders Kaseorg
  • Date: 2008-12-29 21:10:48 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20081229211048-pnkoyadfmoolhjvq
Tags: 0.1.2-1
* New upstream version 0.1.2.
  + Fixed grammar in error messages (from YAML::XS::LibYAML).
  + Rewritten whitespace detection in the scalar analyzer and block
    scalar writers (ported from PyYAML).
  + Fixed emitting folded scalars with trailing breaks; Forced emitting
    of a document end indicator when there is a possibility of ambiguous
    parsing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/group__emitter.html
1
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">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
3
<title>yaml: Emitter Definitions</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
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>
 
7
<!-- Generated by Doxygen 1.5.6 -->
 
8
<div class="navigation" id="top">
 
9
  <div class="tabs">
 
10
    <ul>
 
11
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
12
      <li><a href="modules.html"><span>Modules</span></a></li>
 
13
      <li><a href="annotated.html"><span>Data&nbsp;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">
15
19
<h1>Emitter Definitions</h1><table border="0" cellpadding="0" cellspacing="0">
16
20
<tr><td></td></tr>
17
21
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
22
26
<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
27
 
24
28
<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="" -->
26
 
typedef 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>
 
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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#g0889461fa3efe8eee881aef48a4ba6b2">yaml_emitter_state_t</a></td></tr>
27
30
 
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>
 
31
<tr><td class="mdescLeft">&nbsp;</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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#g4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a></td></tr>
30
33
 
31
34
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The emitter structure.  <a href="#g4ce3e054f0016c49d9e8c36d359e710b"></a><br></td></tr>
32
35
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
138
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>
139
142
<dl compact><dt><b>Parameters:</b></dt><dd>
140
143
  <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>
 
144
    <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" title="Set a generic output handler.">yaml_emitter_set_output()</a>. </td></tr>
142
145
    <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
146
    <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
147
  </table>
147
150
 
148
151
</div>
149
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
 
 
168
</div>
 
169
</div><p>
150
170
<a class="anchor" name="g4ce3e054f0016c49d9e8c36d359e710b"></a><!-- doxytag: member="yaml.h::yaml_emitter_t" ref="g4ce3e054f0016c49d9e8c36d359e710b" args="" -->
151
171
<div class="memitem">
152
172
<div class="memproto">
182
202
<dl compact><dt><b>Enumerator: </b></dt><dd>
183
203
<table border="0" cellspacing="2" cellpadding="0">
184
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>&nbsp;</td><td>
185
 
Expect STREAM-START. </td></tr>
 
205
Expect STREAM-START. 
 
206
<p>
 
207
</td></tr>
186
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>&nbsp;</td><td>
187
 
Expect the first DOCUMENT-START or STREAM-END. </td></tr>
 
209
Expect the first DOCUMENT-START or STREAM-END. 
 
210
<p>
 
211
</td></tr>
188
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>&nbsp;</td><td>
189
 
Expect DOCUMENT-START or STREAM-END. </td></tr>
 
213
Expect DOCUMENT-START or STREAM-END. 
 
214
<p>
 
215
</td></tr>
190
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>&nbsp;</td><td>
191
 
Expect the content of a document. </td></tr>
 
217
Expect the content of a document. 
 
218
<p>
 
219
</td></tr>
192
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>&nbsp;</td><td>
193
 
Expect DOCUMENT-END. </td></tr>
 
221
Expect DOCUMENT-END. 
 
222
<p>
 
223
</td></tr>
194
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>&nbsp;</td><td>
195
 
Expect the first item of a flow sequence. </td></tr>
 
225
Expect the first item of a flow sequence. 
 
226
<p>
 
227
</td></tr>
196
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>&nbsp;</td><td>
197
 
Expect an item of a flow sequence. </td></tr>
 
229
Expect an item of a flow sequence. 
 
230
<p>
 
231
</td></tr>
198
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>&nbsp;</td><td>
199
 
Expect the first key of a flow mapping. </td></tr>
 
233
Expect the first key of a flow mapping. 
 
234
<p>
 
235
</td></tr>
200
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>&nbsp;</td><td>
201
 
Expect a key of a flow mapping. </td></tr>
 
237
Expect a key of a flow mapping. 
 
238
<p>
 
239
</td></tr>
202
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>&nbsp;</td><td>
203
 
Expect a value for a simple key of a flow mapping. </td></tr>
 
241
Expect a value for a simple key of a flow mapping. 
 
242
<p>
 
243
</td></tr>
204
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>&nbsp;</td><td>
205
 
Expect a value of a flow mapping. </td></tr>
 
245
Expect a value of a flow mapping. 
 
246
<p>
 
247
</td></tr>
206
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>&nbsp;</td><td>
207
 
Expect the first item of a block sequence. </td></tr>
 
249
Expect the first item of a block sequence. 
 
250
<p>
 
251
</td></tr>
208
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>&nbsp;</td><td>
209
 
Expect an item of a block sequence. </td></tr>
 
253
Expect an item of a block sequence. 
 
254
<p>
 
255
</td></tr>
210
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>&nbsp;</td><td>
211
 
Expect the first key of a block mapping. </td></tr>
 
257
Expect the first key of a block mapping. 
 
258
<p>
 
259
</td></tr>
212
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>&nbsp;</td><td>
213
 
Expect the key of a block mapping. </td></tr>
 
261
Expect the key of a block mapping. 
 
262
<p>
 
263
</td></tr>
214
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>&nbsp;</td><td>
215
 
Expect a value for a simple key of a block mapping. </td></tr>
 
265
Expect a value for a simple key of a block mapping. 
 
266
<p>
 
267
</td></tr>
216
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>&nbsp;</td><td>
217
 
Expect a value of a block mapping. </td></tr>
 
269
Expect a value of a block mapping. 
 
270
<p>
 
271
</td></tr>
218
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>&nbsp;</td><td>
219
 
Expect nothing. </td></tr>
 
273
Expect nothing. 
 
274
<p>
 
275
</td></tr>
220
276
</table>
221
277
</dl>
222
278
 
233
289
          <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> *&nbsp;</td>
234
290
          <td class="paramname"> <em>emitter</em>          </td>
235
291
          <td>&nbsp;)&nbsp;</td>
236
 
          <td width="100%"></td>
 
292
          <td></td>
237
293
        </tr>
238
294
      </table>
239
295
</div>
242
298
<p>
243
299
Initialize an emitter. 
244
300
<p>
245
 
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">yaml_emitter_delete()</a> function.<p>
 
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>
246
302
<dl compact><dt><b>Parameters:</b></dt><dd>
247
303
  <table border="0" cellspacing="2" cellpadding="0">
248
304
    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>emitter</em>&nbsp;</td><td>An empty parser object.</td></tr>
262
318
          <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> *&nbsp;</td>
263
319
          <td class="paramname"> <em>emitter</em>          </td>
264
320
          <td>&nbsp;)&nbsp;</td>
265
 
          <td width="100%"></td>
 
321
          <td></td>
266
322
        </tr>
267
323
      </table>
268
324
</div>
310
366
        <tr>
311
367
          <td></td>
312
368
          <td>)</td>
313
 
          <td></td><td></td><td width="100%"></td>
 
369
          <td></td><td></td><td></td>
314
370
        </tr>
315
371
      </table>
316
372
</div>
350
406
        <tr>
351
407
          <td></td>
352
408
          <td>)</td>
353
 
          <td></td><td></td><td width="100%"></td>
 
409
          <td></td><td></td><td></td>
354
410
        </tr>
355
411
      </table>
356
412
</div>
394
450
        <tr>
395
451
          <td></td>
396
452
          <td>)</td>
397
 
          <td></td><td></td><td width="100%"></td>
 
453
          <td></td><td></td><td></td>
398
454
        </tr>
399
455
      </table>
400
456
</div>
432
488
        <tr>
433
489
          <td></td>
434
490
          <td>)</td>
435
 
          <td></td><td></td><td width="100%"></td>
 
491
          <td></td><td></td><td></td>
436
492
        </tr>
437
493
      </table>
438
494
</div>
469
525
        <tr>
470
526
          <td></td>
471
527
          <td>)</td>
472
 
          <td></td><td></td><td width="100%"></td>
 
528
          <td></td><td></td><td></td>
473
529
        </tr>
474
530
      </table>
475
531
</div>
506
562
        <tr>
507
563
          <td></td>
508
564
          <td>)</td>
509
 
          <td></td><td></td><td width="100%"></td>
 
565
          <td></td><td></td><td></td>
510
566
        </tr>
511
567
      </table>
512
568
</div>
543
599
        <tr>
544
600
          <td></td>
545
601
          <td>)</td>
546
 
          <td></td><td></td><td width="100%"></td>
 
602
          <td></td><td></td><td></td>
547
603
        </tr>
548
604
      </table>
549
605
</div>
581
637
        <tr>
582
638
          <td></td>
583
639
          <td>)</td>
584
 
          <td></td><td></td><td width="100%"></td>
 
640
          <td></td><td></td><td></td>
585
641
        </tr>
586
642
      </table>
587
643
</div>
618
674
        <tr>
619
675
          <td></td>
620
676
          <td>)</td>
621
 
          <td></td><td></td><td width="100%"></td>
 
677
          <td></td><td></td><td></td>
622
678
        </tr>
623
679
      </table>
624
680
</div>
655
711
        <tr>
656
712
          <td></td>
657
713
          <td>)</td>
658
 
          <td></td><td></td><td width="100%"></td>
 
714
          <td></td><td></td><td></td>
659
715
        </tr>
660
716
      </table>
661
717
</div>
664
720
<p>
665
721
Emit an event. 
666
722
<p>
667
 
The 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>
 
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>
668
724
<dl compact><dt><b>Parameters:</b></dt><dd>
669
725
  <table border="0" cellspacing="2" cellpadding="0">
670
726
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>emitter</em>&nbsp;</td><td>An emitter object. </td></tr>
685
741
          <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> *&nbsp;</td>
686
742
          <td class="paramname"> <em>emitter</em>          </td>
687
743
          <td>&nbsp;)&nbsp;</td>
688
 
          <td width="100%"></td>
 
744
          <td></td>
689
745
        </tr>
690
746
      </table>
691
747
</div>
694
750
<p>
695
751
Start a YAML stream. 
696
752
<p>
697
 
This function should be used before <a class="el" href="group__emitter.html#g5f0306abe9bff373b5bc339913b3769c">yaml_emitter_dump()</a> is called.<p>
 
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>
698
754
<dl compact><dt><b>Parameters:</b></dt><dd>
699
755
  <table border="0" cellspacing="2" cellpadding="0">
700
756
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>emitter</em>&nbsp;</td><td>An emitter object.</td></tr>
714
770
          <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> *&nbsp;</td>
715
771
          <td class="paramname"> <em>emitter</em>          </td>
716
772
          <td>&nbsp;)&nbsp;</td>
717
 
          <td width="100%"></td>
 
773
          <td></td>
718
774
        </tr>
719
775
      </table>
720
776
</div>
723
779
<p>
724
780
Finish a YAML stream. 
725
781
<p>
726
 
This function should be used after <a class="el" href="group__emitter.html#g5f0306abe9bff373b5bc339913b3769c">yaml_emitter_dump()</a> is called.<p>
 
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>
727
783
<dl compact><dt><b>Parameters:</b></dt><dd>
728
784
  <table border="0" cellspacing="2" cellpadding="0">
729
785
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>emitter</em>&nbsp;</td><td>An emitter object.</td></tr>
752
808
        <tr>
753
809
          <td></td>
754
810
          <td>)</td>
755
 
          <td></td><td></td><td width="100%"></td>
 
811
          <td></td><td></td><td></td>
756
812
        </tr>
757
813
      </table>
758
814
</div>
761
817
<p>
762
818
Emit a YAML document. 
763
819
<p>
764
 
The 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>
 
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>
765
821
<dl compact><dt><b>Parameters:</b></dt><dd>
766
822
  <table border="0" cellspacing="2" cellpadding="0">
767
823
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>emitter</em>&nbsp;</td><td>An emitter object. </td></tr>
782
838
          <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> *&nbsp;</td>
783
839
          <td class="paramname"> <em>emitter</em>          </td>
784
840
          <td>&nbsp;)&nbsp;</td>
785
 
          <td width="100%"></td>
 
841
          <td></td>
786
842
        </tr>
787
843
      </table>
788
844
</div>
800
856
 
801
857
</div>
802
858
</div><p>
803
 
<hr size="1"><address style="align: right;"><small>Generated on Thu May 31 22:50:59 2007 for yaml by&nbsp;
 
859
</div>
 
860
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 28 01:19:28 2008 for yaml by&nbsp;
804
861
<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>
 
862
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
806
863
</body>
807
864
</html>