source: trunk/packages/libyaml/doc/html/structyaml__event__s.html @ 1464

Last change on this file since 1464 was 898, checked in by hartmans, 16 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: 14.6 KB
Line 
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: yaml_event_s Struct Reference</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 id="current"><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<div class="tabs">
16  <ul>
17    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
18    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
19  </ul></div>
20<h1>yaml_event_s Struct Reference<br>
21<small>
22[<a class="el" href="group__events.html">Events</a>]</small>
23</h1><!-- doxytag: class="yaml_event_s" -->The event structure. 
24<a href="#_details">More...</a>
25<p>
26<code>#include &lt;yaml.h&gt;</code>
27<p>
28<table border="0" cellpadding="0" cellspacing="0">
29<tr><td></td></tr>
30<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
31<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ff08bc3df4859d5b3a804e8c011cac51"></a><!-- doxytag: member="yaml_event_s::type" ref="ff08bc3df4859d5b3a804e8c011cac51" args="" -->
32<a class="el" href="group__events.html#g8934661be36bd7c9d17a8af69eff89a1">yaml_event_type_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__event__s.html#ff08bc3df4859d5b3a804e8c011cac51">type</a></td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The event type. <br></td></tr>
35<tr><td class="memItemLeft" nowrap><a class="anchor" name="0b8f9cce08e49459e4bab89035dbf6c6"></a><!-- doxytag: member="yaml_event_s::data" ref="0b8f9cce08e49459e4bab89035dbf6c6" args="" -->
36union {</td></tr>
37
38<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;struct {</td></tr>
39
40<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#g2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#92139ba6ae79089fd9a2f5f4aeaf733f">encoding</a></td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The document encoding. <br></td></tr>
43<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#18946df9b7c815dd7fb30103c02a9e24">stream_start</a></td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The stream parameters (for <code>YAML_STREAM_START_EVENT</code>). <br></td></tr>
46<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;struct {</td></tr>
47
48<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#5cef7981358ecefdf9d4780b3eacd39b">version_directive</a></td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The version directive. <br></td></tr>
51<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;struct {</td></tr>
52
53<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#74d7f521a559305585009ab503bee16b">start</a></td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the tag directives list. <br></td></tr>
56<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#115b4a9797f3a72cd78d42c85100317c">end</a></td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the tag directives list. <br></td></tr>
59<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#162ce89a77e706d68649d40e1a520e1f">tag_directives</a></td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list of tag directives. <br></td></tr>
62<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#3cbb10e276d55890ee2fa802dd6290e1">implicit</a></td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the document indicator implicit? <br></td></tr>
65<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#ed593fadbeb898d6d90b0c62522a82cc">document_start</a></td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The document parameters (for <code>YAML_DOCUMENT_START_EVENT</code>). <br></td></tr>
68<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;struct {</td></tr>
69
70<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#3cbb10e276d55890ee2fa802dd6290e1">implicit</a></td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the document end indicator implicit? <br></td></tr>
73<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#cffec5f24c01bb6bfb0c93a9bf1a803e">document_end</a></td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The document end parameters (for <code>YAML_DOCUMENT_END_EVENT</code>). <br></td></tr>
76<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;struct {</td></tr>
77
78<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#aa97ab683d28e5f611042d0fbd929125">anchor</a></td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The anchor. <br></td></tr>
81<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#c21f0f1e12207b8fd4f02496259f6c0b">alias</a></td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The alias parameters (for <code>YAML_ALIAS_EVENT</code>). <br></td></tr>
84<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;struct {</td></tr>
85
86<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#aa97ab683d28e5f611042d0fbd929125">anchor</a></td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The anchor. <br></td></tr>
89<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#4daf9ed2683d79f2be7e89ca7d06801c">tag</a></td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag. <br></td></tr>
92<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#23436bdddb447d0fc217bab5c5b04a36">value</a></td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The scalar value. <br></td></tr>
95<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;size_t&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#15618ee917746d28d97ad8eb9639e141">length</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The length of the scalar value. <br></td></tr>
98<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#c3600acbcc6b4787f1ec3511976a3151">plain_implicit</a></td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the tag optional for the plain style? <br></td></tr>
101<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#9ce2441d08d9cf6a1bf9f28f5ee17f68">quoted_implicit</a></td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the tag optional for any non-plain style? <br></td></tr>
104<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__styles.html#g3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#b107f895698f70560a5c344fc60ff498">style</a></td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The scalar style. <br></td></tr>
107<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#3753b4c5d10040d75f7c7f4b56c42549">scalar</a></td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The scalar parameters (for <code>YAML_SCALAR_EVENT</code>). <br></td></tr>
110<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;struct {</td></tr>
111
112<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#aa97ab683d28e5f611042d0fbd929125">anchor</a></td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The anchor. <br></td></tr>
115<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#4daf9ed2683d79f2be7e89ca7d06801c">tag</a></td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag. <br></td></tr>
118<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#3cbb10e276d55890ee2fa802dd6290e1">implicit</a></td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the tag optional? <br></td></tr>
121<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__styles.html#g58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#2ac1305583a8e7e2247738116bca6b3b">style</a></td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The sequence style. <br></td></tr>
124<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#632895e022fbf29ab24a816893a8580f">sequence_start</a></td></tr>
125
126<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The sequence parameters (for <code>YAML_SEQUENCE_START_EVENT</code>). <br></td></tr>
127<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;struct {</td></tr>
128
129<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#aa97ab683d28e5f611042d0fbd929125">anchor</a></td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The anchor. <br></td></tr>
132<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#4daf9ed2683d79f2be7e89ca7d06801c">tag</a></td></tr>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag. <br></td></tr>
135<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#3cbb10e276d55890ee2fa802dd6290e1">implicit</a></td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the tag optional? <br></td></tr>
138<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a class="el" href="group__styles.html#gb47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#682a60e9a72e100357a38dd6434ad4f9">style</a></td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mapping style. <br></td></tr>
141<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__event__s.html#361b28413783f92797e6bfe03e9abaa1">mapping_start</a></td></tr>
142
143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mapping parameters (for <code>YAML_MAPPING_START_EVENT</code>). <br></td></tr>
144<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__event__s.html#0b8f9cce08e49459e4bab89035dbf6c6">data</a></td></tr>
145
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The event data. <br></td></tr>
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eaf86eb588e75232e1b73e8213eb3e31"></a><!-- doxytag: member="yaml_event_s::start_mark" ref="eaf86eb588e75232e1b73e8213eb3e31" args="" -->
148<a class="el" href="structyaml__mark__s.html">yaml_mark_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__event__s.html#eaf86eb588e75232e1b73e8213eb3e31">start_mark</a></td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the event. <br></td></tr>
151<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9307f91473094c229738b03d223bc4ba"></a><!-- doxytag: member="yaml_event_s::end_mark" ref="9307f91473094c229738b03d223bc4ba" args="" -->
152<a class="el" href="structyaml__mark__s.html">yaml_mark_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__event__s.html#9307f91473094c229738b03d223bc4ba">end_mark</a></td></tr>
153
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the event. <br></td></tr>
155</table>
156<hr><a name="_details"></a><h2>Detailed Description</h2>
157The event structure.
158<p>
159<hr>The documentation for this struct was generated from the following file:<ul>
160<li><a class="el" href="yaml_8h.html">yaml.h</a></ul>
161<hr size="1"><address style="align: right;"><small>Generated on Thu May 31 22:50:59 2007 for yaml by&nbsp;
162<a href="http://www.doxygen.org/index.html">
163<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
164</body>
165</html>
Note: See TracBrowser for help on using the repository browser.