1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>yaml: yaml_node_s Struct Reference</title>
6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
10 <!-- Generated by Doxygen 1.7.1 -->
11 <div class="navigation" id="top">
14 <li><a href="index.html"><span>Main Page</span></a></li>
15 <li><a href="modules.html"><span>Modules</span></a></li>
16 <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
17 <li><a href="files.html"><span>Files</span></a></li>
22 <li><a href="annotated.html"><span>Data Structures</span></a></li>
23 <li><a href="functions.html"><span>Data Fields</span></a></li>
29 <a href="#pub-attribs">Data Fields</a> </div>
30 <div class="headertitle">
31 <h1>yaml_node_s Struct Reference<br/>
33 [<a class="el" href="group__nodes.html">Nodes</a>]</small>
36 <div class="contents">
37 <!-- doxytag: class="yaml_node_s" -->
38 <p>The node structure.
39 <a href="#_details">More...</a></p>
41 <p><code>#include <yaml.h></code></p>
42 <table class="memberdecls">
43 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
44 Data Fields</h2></td></tr>
45 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html#a1db4ea72e13be65ec42339ce47d19669">type</a></td></tr>
46 <tr><td class="mdescLeft"> </td><td class="mdescRight">The node type. <a href="#a1db4ea72e13be65ec42339ce47d19669"></a><br/></td></tr>
47 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html#aa753358ea6d9d221b7b188832d47fefa">tag</a></td></tr>
48 <tr><td class="mdescLeft"> </td><td class="mdescRight">The node tag. <a href="#aa753358ea6d9d221b7b188832d47fefa"></a><br/></td></tr>
49 <tr><td class="memItemLeft" >union {</td></tr>
50 <tr><td class="memItemLeft" > struct {</td></tr>
51 <tr><td class="memItemLeft" > <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * <a class="el" href="structyaml__node__s.html#a0d444412a29609d62699267ae72f971d">value</a></td></tr>
52 <tr><td class="mdescLeft"> </td><td class="mdescRight">The scalar value. <a href="#a0ce51acf3b3e7e3798fd59db6048215a"></a><br/></td></tr>
53 <tr><td class="memItemLeft" > size_t <a class="el" href="structyaml__node__s.html#ad90dd9926d9debbaa48eb5339bd9fc36">length</a></td></tr>
54 <tr><td class="mdescLeft"> </td><td class="mdescRight">The length of the scalar value. <a href="#aebc3bbc2fe05ccf793cfd9d0697d7411"></a><br/></td></tr>
55 <tr><td class="memItemLeft" > <a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> <a class="el" href="structyaml__node__s.html#a362960375516e77a130c412ef10ef55d">style</a></td></tr>
56 <tr><td class="mdescLeft"> </td><td class="mdescRight">The scalar style. <a href="#aedd8f01db928d283efb35d07bd594118"></a><br/></td></tr>
57 <tr><td class="memItemLeft" valign="top"> } <a class="el" href="structyaml__node__s.html#a688583a2649848aed700d7e07d9efac9">scalar</a></td></tr>
58 <tr><td class="mdescLeft"> </td><td class="mdescRight">The scalar parameters (for <code>YAML_SCALAR_NODE</code>). <a href="#a20ef91ea5b107f7e160f6626ae94e757"></a><br/></td></tr>
59 <tr><td class="memItemLeft" > struct {</td></tr>
60 <tr><td class="memItemLeft" > struct {</td></tr>
61 <tr><td class="memItemLeft" > <a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a> * <a class="el" href="structyaml__node__s.html#a2e1001a0a7b068d4b2543a93d4cf60d4">start</a></td></tr>
62 <tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the stack. <a href="#adff33843f3a55f50dab6319a3622112e"></a><br/></td></tr>
63 <tr><td class="memItemLeft" > <a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a> * <a class="el" href="structyaml__node__s.html#ac9b3d891f9fcd5462289823716deca0e">end</a></td></tr>
64 <tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the stack. <a href="#aadabab91314f9a90437abd04f6ff07cb"></a><br/></td></tr>
65 <tr><td class="memItemLeft" > <a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a> * <a class="el" href="structyaml__node__s.html#a510326726569a06a11119f12649787cf">top</a></td></tr>
66 <tr><td class="mdescLeft"> </td><td class="mdescRight">The top of the stack. <a href="#a87ff5c5f9cfa26fb410a2fdfef4af6e6"></a><br/></td></tr>
67 <tr><td class="memItemLeft" valign="top"> } <a class="el" href="structyaml__node__s.html#a6b340541cc012ac5aacdcaa46ced097a">items</a></td></tr>
68 <tr><td class="mdescLeft"> </td><td class="mdescRight">The stack of sequence items. <a href="#a20d9072496e270ec80741ae436cfc78c"></a><br/></td></tr>
69 <tr><td class="memItemLeft" > <a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> <a class="el" href="structyaml__node__s.html#a242be04ec3709138264175e3e5b50dbe">style</a></td></tr>
70 <tr><td class="mdescLeft"> </td><td class="mdescRight">The sequence style. <a href="#aef5300a10030a153ce20e58bc2e1c886"></a><br/></td></tr>
71 <tr><td class="memItemLeft" valign="top"> } <a class="el" href="structyaml__node__s.html#afe215962139fac93b965cc2acd71452b">sequence</a></td></tr>
72 <tr><td class="mdescLeft"> </td><td class="mdescRight">The sequence parameters (for <code>YAML_SEQUENCE_NODE</code>). <a href="#ab302f3c85f1b7f6896a7571479e0d748"></a><br/></td></tr>
73 <tr><td class="memItemLeft" > struct {</td></tr>
74 <tr><td class="memItemLeft" > struct {</td></tr>
75 <tr><td class="memItemLeft" > <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_t</a> * <a class="el" href="structyaml__node__s.html#a82afddfe1cf7f1a346d931ad4896d3de">start</a></td></tr>
76 <tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the stack. <a href="#ae3264b106666197e1c01601a5b8c5f69"></a><br/></td></tr>
77 <tr><td class="memItemLeft" > <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_t</a> * <a class="el" href="structyaml__node__s.html#a1827ba7f3e7f7e94171fa20ade25345d">end</a></td></tr>
78 <tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the stack. <a href="#ad4193067b681fb09b4e0ce5d7be32824"></a><br/></td></tr>
79 <tr><td class="memItemLeft" > <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_t</a> * <a class="el" href="structyaml__node__s.html#aa420f88720907fe02b1d1595c9351d59">top</a></td></tr>
80 <tr><td class="mdescLeft"> </td><td class="mdescRight">The top of the stack. <a href="#a3b512e63e6089f84064e4938d79d232e"></a><br/></td></tr>
81 <tr><td class="memItemLeft" valign="top"> } <a class="el" href="structyaml__node__s.html#a830a080bbed021eb230ef644e4680909">pairs</a></td></tr>
82 <tr><td class="mdescLeft"> </td><td class="mdescRight">The stack of mapping pairs (key, value). <a href="#ac44360d96e1cf1d21434dad925b34abd"></a><br/></td></tr>
83 <tr><td class="memItemLeft" > <a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> <a class="el" href="structyaml__node__s.html#a5b80d97f64e2867927404fedb65949c6">style</a></td></tr>
84 <tr><td class="mdescLeft"> </td><td class="mdescRight">The mapping style. <a href="#a4071cd026bfc0eb097b8dac6c3b7cbb5"></a><br/></td></tr>
85 <tr><td class="memItemLeft" valign="top"> } <a class="el" href="structyaml__node__s.html#ab18dc5c573885a08a92e113dcb7fb361">mapping</a></td></tr>
86 <tr><td class="mdescLeft"> </td><td class="mdescRight">The mapping parameters (for <code>YAML_MAPPING_NODE</code>). <a href="#a37018c73209f623ca1e38c8506533080"></a><br/></td></tr>
87 <tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html#a7e1be921e921f2d0911e450a063b1344">data</a></td></tr>
88 <tr><td class="mdescLeft"> </td><td class="mdescRight">The node data. <a href="#a7e1be921e921f2d0911e450a063b1344"></a><br/></td></tr>
89 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html#ac17afa3b3a9ff4703bb4983163bfae5c">start_mark</a></td></tr>
90 <tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the node. <a href="#ac17afa3b3a9ff4703bb4983163bfae5c"></a><br/></td></tr>
91 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html#a63144671fd16f94f72c6d537360f7328">end_mark</a></td></tr>
92 <tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the node. <a href="#a63144671fd16f94f72c6d537360f7328"></a><br/></td></tr>
94 <hr/><a name="_details"></a><h2>Detailed Description</h2>
95 <p>The node structure. </p>
96 <hr/><h2>Field Documentation</h2>
97 <a class="anchor" id="a1db4ea72e13be65ec42339ce47d19669"></a><!-- doxytag: member="yaml_node_s::type" ref="a1db4ea72e13be65ec42339ce47d19669" args="" -->
99 <div class="memproto">
100 <table class="memname">
102 <td class="memname"><a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a> <a class="el" href="structyaml__node__s.html#a1db4ea72e13be65ec42339ce47d19669">yaml_node_s::type</a></td>
108 <p>The node type. </p>
112 <a class="anchor" id="aa753358ea6d9d221b7b188832d47fefa"></a><!-- doxytag: member="yaml_node_s::tag" ref="aa753358ea6d9d221b7b188832d47fefa" args="" -->
113 <div class="memitem">
114 <div class="memproto">
115 <table class="memname">
117 <td class="memname"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a>* <a class="el" href="structyaml__node__s.html#aa753358ea6d9d221b7b188832d47fefa">yaml_node_s::tag</a></td>
123 <p>The node tag. </p>
127 <a class="anchor" id="a0d444412a29609d62699267ae72f971d"></a><!-- doxytag: member="yaml_node_s::value" ref="a0d444412a29609d62699267ae72f971d" args="" -->
128 <div class="memitem">
129 <div class="memproto">
130 <table class="memname">
132 <td class="memname"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a>* <a class="el" href="structyaml__node__s.html#a0d444412a29609d62699267ae72f971d">yaml_node_s::value</a></td>
138 <p>The scalar value. </p>
142 <a class="anchor" id="ad90dd9926d9debbaa48eb5339bd9fc36"></a><!-- doxytag: member="yaml_node_s::length" ref="ad90dd9926d9debbaa48eb5339bd9fc36" args="" -->
143 <div class="memitem">
144 <div class="memproto">
145 <table class="memname">
147 <td class="memname">size_t <a class="el" href="structyaml__node__s.html#ad90dd9926d9debbaa48eb5339bd9fc36">yaml_node_s::length</a></td>
153 <p>The length of the scalar value. </p>
157 <a class="anchor" id="a362960375516e77a130c412ef10ef55d"></a><!-- doxytag: member="yaml_node_s::style" ref="a362960375516e77a130c412ef10ef55d" args="" -->
158 <div class="memitem">
159 <div class="memproto">
160 <table class="memname">
162 <td class="memname"><a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> <a class="el" href="structyaml__node__s.html#a362960375516e77a130c412ef10ef55d">yaml_node_s::style</a></td>
168 <p>The scalar style. </p>
172 <a class="anchor" id="a688583a2649848aed700d7e07d9efac9"></a><!-- doxytag: member="yaml_node_s::scalar" ref="a688583a2649848aed700d7e07d9efac9" args="" -->
173 <div class="memitem">
174 <div class="memproto">
175 <table class="memname">
177 <td class="memname">struct { ... } <a class="el" href="structyaml__node__s.html#a688583a2649848aed700d7e07d9efac9">yaml_node_s::scalar</a></td>
183 <p>The scalar parameters (for <code>YAML_SCALAR_NODE</code>). </p>
187 <a class="anchor" id="a2e1001a0a7b068d4b2543a93d4cf60d4"></a><!-- doxytag: member="yaml_node_s::start" ref="a2e1001a0a7b068d4b2543a93d4cf60d4" args="" -->
188 <div class="memitem">
189 <div class="memproto">
190 <table class="memname">
192 <td class="memname"><a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a>* <a class="el" href="structyaml__node__s.html#a2e1001a0a7b068d4b2543a93d4cf60d4">yaml_node_s::start</a></td>
198 <p>The beginning of the stack. </p>
202 <a class="anchor" id="ac9b3d891f9fcd5462289823716deca0e"></a><!-- doxytag: member="yaml_node_s::end" ref="ac9b3d891f9fcd5462289823716deca0e" args="" -->
203 <div class="memitem">
204 <div class="memproto">
205 <table class="memname">
207 <td class="memname"><a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a>* <a class="el" href="structyaml__node__s.html#ac9b3d891f9fcd5462289823716deca0e">yaml_node_s::end</a></td>
213 <p>The end of the stack. </p>
217 <a class="anchor" id="a510326726569a06a11119f12649787cf"></a><!-- doxytag: member="yaml_node_s::top" ref="a510326726569a06a11119f12649787cf" args="" -->
218 <div class="memitem">
219 <div class="memproto">
220 <table class="memname">
222 <td class="memname"><a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a>* <a class="el" href="structyaml__node__s.html#a510326726569a06a11119f12649787cf">yaml_node_s::top</a></td>
228 <p>The top of the stack. </p>
232 <a class="anchor" id="a6b340541cc012ac5aacdcaa46ced097a"></a><!-- doxytag: member="yaml_node_s::items" ref="a6b340541cc012ac5aacdcaa46ced097a" args="" -->
233 <div class="memitem">
234 <div class="memproto">
235 <table class="memname">
237 <td class="memname">struct { ... } ::@21 <a class="el" href="structyaml__node__s.html#a6b340541cc012ac5aacdcaa46ced097a">yaml_node_s::items</a></td>
243 <p>The stack of sequence items. </p>
247 <a class="anchor" id="a242be04ec3709138264175e3e5b50dbe"></a><!-- doxytag: member="yaml_node_s::style" ref="a242be04ec3709138264175e3e5b50dbe" args="" -->
248 <div class="memitem">
249 <div class="memproto">
250 <table class="memname">
252 <td class="memname"><a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> <a class="el" href="structyaml__node__s.html#a362960375516e77a130c412ef10ef55d">yaml_node_s::style</a></td>
258 <p>The sequence style. </p>
262 <a class="anchor" id="afe215962139fac93b965cc2acd71452b"></a><!-- doxytag: member="yaml_node_s::sequence" ref="afe215962139fac93b965cc2acd71452b" args="" -->
263 <div class="memitem">
264 <div class="memproto">
265 <table class="memname">
267 <td class="memname">struct { ... } <a class="el" href="structyaml__node__s.html#afe215962139fac93b965cc2acd71452b">yaml_node_s::sequence</a></td>
273 <p>The sequence parameters (for <code>YAML_SEQUENCE_NODE</code>). </p>
277 <a class="anchor" id="a82afddfe1cf7f1a346d931ad4896d3de"></a><!-- doxytag: member="yaml_node_s::start" ref="a82afddfe1cf7f1a346d931ad4896d3de" args="" -->
278 <div class="memitem">
279 <div class="memproto">
280 <table class="memname">
282 <td class="memname"><a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_t</a>* <a class="el" href="structyaml__node__s.html#a2e1001a0a7b068d4b2543a93d4cf60d4">yaml_node_s::start</a></td>
288 <p>The beginning of the stack. </p>
292 <a class="anchor" id="a1827ba7f3e7f7e94171fa20ade25345d"></a><!-- doxytag: member="yaml_node_s::end" ref="a1827ba7f3e7f7e94171fa20ade25345d" args="" -->
293 <div class="memitem">
294 <div class="memproto">
295 <table class="memname">
297 <td class="memname"><a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_t</a>* <a class="el" href="structyaml__node__s.html#ac9b3d891f9fcd5462289823716deca0e">yaml_node_s::end</a></td>
303 <p>The end of the stack. </p>
307 <a class="anchor" id="aa420f88720907fe02b1d1595c9351d59"></a><!-- doxytag: member="yaml_node_s::top" ref="aa420f88720907fe02b1d1595c9351d59" args="" -->
308 <div class="memitem">
309 <div class="memproto">
310 <table class="memname">
312 <td class="memname"><a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_t</a>* <a class="el" href="structyaml__node__s.html#a510326726569a06a11119f12649787cf">yaml_node_s::top</a></td>
318 <p>The top of the stack. </p>
322 <a class="anchor" id="a830a080bbed021eb230ef644e4680909"></a><!-- doxytag: member="yaml_node_s::pairs" ref="a830a080bbed021eb230ef644e4680909" args="" -->
323 <div class="memitem">
324 <div class="memproto">
325 <table class="memname">
327 <td class="memname">struct { ... } ::@22 <a class="el" href="structyaml__node__s.html#a830a080bbed021eb230ef644e4680909">yaml_node_s::pairs</a></td>
333 <p>The stack of mapping pairs (key, value). </p>
337 <a class="anchor" id="a5b80d97f64e2867927404fedb65949c6"></a><!-- doxytag: member="yaml_node_s::style" ref="a5b80d97f64e2867927404fedb65949c6" args="" -->
338 <div class="memitem">
339 <div class="memproto">
340 <table class="memname">
342 <td class="memname"><a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> <a class="el" href="structyaml__node__s.html#a362960375516e77a130c412ef10ef55d">yaml_node_s::style</a></td>
348 <p>The mapping style. </p>
352 <a class="anchor" id="ab18dc5c573885a08a92e113dcb7fb361"></a><!-- doxytag: member="yaml_node_s::mapping" ref="ab18dc5c573885a08a92e113dcb7fb361" args="" -->
353 <div class="memitem">
354 <div class="memproto">
355 <table class="memname">
357 <td class="memname">struct { ... } <a class="el" href="structyaml__node__s.html#ab18dc5c573885a08a92e113dcb7fb361">yaml_node_s::mapping</a></td>
363 <p>The mapping parameters (for <code>YAML_MAPPING_NODE</code>). </p>
367 <a class="anchor" id="a7e1be921e921f2d0911e450a063b1344"></a><!-- doxytag: member="yaml_node_s::data" ref="a7e1be921e921f2d0911e450a063b1344" args="" -->
368 <div class="memitem">
369 <div class="memproto">
370 <table class="memname">
372 <td class="memname">union { ... } <a class="el" href="structyaml__node__s.html#a7e1be921e921f2d0911e450a063b1344">yaml_node_s::data</a></td>
378 <p>The node data. </p>
382 <a class="anchor" id="ac17afa3b3a9ff4703bb4983163bfae5c"></a><!-- doxytag: member="yaml_node_s::start_mark" ref="ac17afa3b3a9ff4703bb4983163bfae5c" args="" -->
383 <div class="memitem">
384 <div class="memproto">
385 <table class="memname">
387 <td class="memname"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> <a class="el" href="structyaml__node__s.html#ac17afa3b3a9ff4703bb4983163bfae5c">yaml_node_s::start_mark</a></td>
393 <p>The beginning of the node. </p>
397 <a class="anchor" id="a63144671fd16f94f72c6d537360f7328"></a><!-- doxytag: member="yaml_node_s::end_mark" ref="a63144671fd16f94f72c6d537360f7328" args="" -->
398 <div class="memitem">
399 <div class="memproto">
400 <table class="memname">
402 <td class="memname"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> <a class="el" href="structyaml__node__s.html#a63144671fd16f94f72c6d537360f7328">yaml_node_s::end_mark</a></td>
408 <p>The end of the node. </p>
412 <hr/>The documentation for this struct was generated from the following file:<ul>
413 <li><a class="el" href="yaml_8h.html">yaml.h</a></li>
416 <hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by
417 <a href="http://www.doxygen.org/index.html">
418 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>