]>
Commit | Line | Data |
---|---|---|
0fbeb4dc AK |
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"> | |
3 | <head> | |
4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | |
059850b5 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
b9668ba4 | 6 | <title>yaml: Nodes</title> |
059850b5 | 7 | |
0fbeb4dc | 8 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
059850b5 AK |
9 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
10 | ||
11 | ||
12 | ||
0fbeb4dc AK |
13 | </head> |
14 | <body> | |
059850b5 AK |
15 | <div id="top"><!-- do not remove this div! --> |
16 | ||
17 | ||
18 | <div id="titlearea"> | |
19 | <table cellspacing="0" cellpadding="0"> | |
20 | <tbody> | |
21 | <tr style="height: 56px;"> | |
22 | ||
23 | ||
24 | <td style="padding-left: 0.5em;"> | |
25 | <div id="projectname">yaml | |
26 |  <span id="projectnumber">0.1.5</span> | |
27 | </div> | |
28 | ||
29 | </td> | |
30 | ||
31 | ||
32 | ||
33 | </tr> | |
34 | </tbody> | |
35 | </table> | |
36 | </div> | |
37 | ||
38 | <!-- Generated by Doxygen 1.7.6.1 --> | |
39 | <div id="navrow1" class="tabs"> | |
0fbeb4dc | 40 | <ul class="tablist"> |
059850b5 | 41 | <li><a href="index.html"><span>Main Page</span></a></li> |
5c706339 | 42 | <li><a href="modules.html"><span>Modules</span></a></li> |
059850b5 | 43 | <li><a href="annotated.html"><span>Data Structures</span></a></li> |
5c706339 AK |
44 | <li><a href="files.html"><span>Files</span></a></li> |
45 | </ul> | |
46 | </div> | |
47 | </div> | |
0fbeb4dc AK |
48 | <div class="header"> |
49 | <div class="summary"> | |
50 | <a href="#nested-classes">Data Structures</a> | | |
51 | <a href="#define-members">Defines</a> | | |
52 | <a href="#typedef-members">Typedefs</a> | | |
53 | <a href="#enum-members">Enumerations</a> | | |
54 | <a href="#func-members">Functions</a> </div> | |
55 | <div class="headertitle"> | |
059850b5 AK |
56 | <div class="title">Nodes</div> </div> |
57 | </div><!--header--> | |
5c706339 | 58 | <div class="contents"> |
0fbeb4dc AK |
59 | <table class="memberdecls"> |
60 | <tr><td colspan="2"><h2><a name="nested-classes"></a> | |
61 | Data Structures</h2></td></tr> | |
059850b5 AK |
62 | <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a></td></tr> |
63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An element of a mapping node. <a href="structyaml__node__pair__s.html#details">More...</a><br/></td></tr> | |
64 | <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html">yaml_node_s</a></td></tr> | |
65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The node structure. <a href="structyaml__node__s.html#details">More...</a><br/></td></tr> | |
66 | <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html">yaml_document_s</a></td></tr> | |
67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The document structure. <a href="structyaml__document__s.html#details">More...</a><br/></td></tr> | |
0fbeb4dc AK |
68 | <tr><td colspan="2"><h2><a name="define-members"></a> |
69 | Defines</h2></td></tr> | |
059850b5 AK |
70 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gadfa882b6e42a3a993d12392d55260b00">YAML_NULL_TAG</a>   "tag:yaml.org,2002:null"</td></tr> |
71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!null</code> with the only possible value: <code>null</code>. <a href="#gadfa882b6e42a3a993d12392d55260b00"></a><br/></td></tr> | |
72 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga312629a1f51e91b136352db988d4d771">YAML_BOOL_TAG</a>   "tag:yaml.org,2002:bool"</td></tr> | |
73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!bool</code> with the values: <code>true</code> and <code>falce</code>. <a href="#ga312629a1f51e91b136352db988d4d771"></a><br/></td></tr> | |
74 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a>   "tag:yaml.org,2002:str"</td></tr> | |
75 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!str</code> for string values. <a href="#gac5dbc6d1f556663edf8db88d6113e931"></a><br/></td></tr> | |
76 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga83263cdb4ffa6ad2f7d9a87281979ff5">YAML_INT_TAG</a>   "tag:yaml.org,2002:int"</td></tr> | |
77 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!int</code> for integer values. <a href="#ga83263cdb4ffa6ad2f7d9a87281979ff5"></a><br/></td></tr> | |
78 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga6ab2ec71fc47cb24f1003b9acdb92843">YAML_FLOAT_TAG</a>   "tag:yaml.org,2002:float"</td></tr> | |
79 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!float</code> for float values. <a href="#ga6ab2ec71fc47cb24f1003b9acdb92843"></a><br/></td></tr> | |
80 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga3e27cca7191234f2e8c95eaf3bc99a73">YAML_TIMESTAMP_TAG</a>   "tag:yaml.org,2002:timestamp"</td></tr> | |
81 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!timestamp</code> for date and time values. <a href="#ga3e27cca7191234f2e8c95eaf3bc99a73"></a><br/></td></tr> | |
82 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a>   "tag:yaml.org,2002:seq"</td></tr> | |
83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!seq</code> is used to denote sequences. <a href="#gaa8284b30f9c9e3f10f6a69c9b882f417"></a><br/></td></tr> | |
84 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a>   "tag:yaml.org,2002:map"</td></tr> | |
85 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!map</code> is used to denote mapping. <a href="#ga22ae99cf3ac014dd76873268fd068c12"></a><br/></td></tr> | |
86 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf6b0c4e819b8f6915515a4f70065aaaa">YAML_DEFAULT_SCALAR_TAG</a>   <a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a></td></tr> | |
87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The default scalar tag is <code>!!str</code>. <a href="#gaf6b0c4e819b8f6915515a4f70065aaaa"></a><br/></td></tr> | |
88 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf195b67002518702e27746d6b4da6124">YAML_DEFAULT_SEQUENCE_TAG</a>   <a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a></td></tr> | |
89 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The default sequence tag is <code>!!seq</code>. <a href="#gaf195b67002518702e27746d6b4da6124"></a><br/></td></tr> | |
90 | <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf7b1f8f0ce5665794510cd3841802a5f">YAML_DEFAULT_MAPPING_TAG</a>   <a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a></td></tr> | |
91 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The default mapping tag is <code>!!map</code>. <a href="#gaf7b1f8f0ce5665794510cd3841802a5f"></a><br/></td></tr> | |
0fbeb4dc AK |
92 | <tr><td colspan="2"><h2><a name="typedef-members"></a> |
93 | Typedefs</h2></td></tr> | |
059850b5 AK |
94 | <tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td></tr> |
95 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Node types. <a href="#gabe020d2fc42d3e896549e9f97da622d2"></a><br/></td></tr> | |
96 | <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__node__s.html">yaml_node_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a></td></tr> | |
97 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The forward definition of a document node structure. <a href="#ga9eaaa233b120b9d9db47de93c294c40f"></a><br/></td></tr> | |
98 | <tr><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a></td></tr> | |
99 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An element of a sequence node. <a href="#ga7cc3581582e778b00c04e99cd3656860"></a><br/></td></tr> | |
100 | <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga90f1c8b83c5c38dc4016afc1cc2050c4">yaml_node_pair_t</a></td></tr> | |
101 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An element of a mapping node. <a href="#ga90f1c8b83c5c38dc4016afc1cc2050c4"></a><br/></td></tr> | |
102 | <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__document__s.html">yaml_document_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a></td></tr> | |
103 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The document structure. <a href="#gad94e064e95baeb22e4f7acc7804e8479"></a><br/></td></tr> | |
0fbeb4dc AK |
104 | <tr><td colspan="2"><h2><a name="enum-members"></a> |
105 | Enumerations</h2></td></tr> | |
059850b5 AK |
106 | <tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> { <br/> |
107 |   <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739">YAML_NO_NODE</a>, | |
0fbeb4dc | 108 | <br/> |
059850b5 | 109 |   <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45">YAML_SCALAR_NODE</a>, |
0fbeb4dc | 110 | <br/> |
059850b5 | 111 |   <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15">YAML_SEQUENCE_NODE</a>, |
0fbeb4dc | 112 | <br/> |
059850b5 | 113 |   <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6">YAML_MAPPING_NODE</a> |
0fbeb4dc | 114 | <br/> |
b9668ba4 | 115 | }</td></tr> |
059850b5 | 116 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Node types. <a href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">More...</a><br/></td></tr> |
0fbeb4dc AK |
117 | <tr><td colspan="2"><h2><a name="func-members"></a> |
118 | Functions</h2></td></tr> | |
059850b5 AK |
119 | <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga62a485c96f3b7962436a0da5e6f3cc89">yaml_document_initialize</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *version_directive, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_start, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_end, int start_implicit, int end_implicit)</td></tr> |
120 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a YAML document. <a href="#ga62a485c96f3b7962436a0da5e6f3cc89"></a><br/></td></tr> | |
121 | <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga2754b1544fb4e110e83fafbc708b0672">yaml_document_delete</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr> | |
122 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Delete a YAML document and all its nodes. <a href="#ga2754b1544fb4e110e83fafbc708b0672"></a><br/></td></tr> | |
123 | <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gafa1feabc9747dbded4dca24e27d3c21a">yaml_document_get_node</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int index)</td></tr> | |
124 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a node of a YAML document. <a href="#gafa1feabc9747dbded4dca24e27d3c21a"></a><br/></td></tr> | |
125 | <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga40eeaa68fb2f3be34c4fe34e7597d324">yaml_document_get_root_node</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr> | |
126 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the root of a YAML document node. <a href="#ga40eeaa68fb2f3be34c4fe34e7597d324"></a><br/></td></tr> | |
127 | <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga45dab8b983b58a005557d4b01f5057b0">yaml_document_add_scalar</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *value, int length, <a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr> | |
128 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a SCALAR node and attach it to the document. <a href="#ga45dab8b983b58a005557d4b01f5057b0"></a><br/></td></tr> | |
129 | <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga83b2f7fdd9a439397a42016bddad7786">yaml_document_add_sequence</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr> | |
130 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a SEQUENCE node and attach it to the document. <a href="#ga83b2f7fdd9a439397a42016bddad7786"></a><br/></td></tr> | |
131 | <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga45a9f8288704f99cd81dc5cb31329d34">yaml_document_add_mapping</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr> | |
132 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a MAPPING node and attach it to the document. <a href="#ga45a9f8288704f99cd81dc5cb31329d34"></a><br/></td></tr> | |
133 | <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga16435917cd6c0261cd390fa8cf173b1b">yaml_document_append_sequence_item</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int sequence, int item)</td></tr> | |
134 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Add an item to a SEQUENCE node. <a href="#ga16435917cd6c0261cd390fa8cf173b1b"></a><br/></td></tr> | |
135 | <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga2db27002d8a9ae06b1729d0ee06553d2">yaml_document_append_mapping_pair</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int mapping, int key, int value)</td></tr> | |
136 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a pair of a key and a value to a MAPPING node. <a href="#ga2db27002d8a9ae06b1729d0ee06553d2"></a><br/></td></tr> | |
b9668ba4 | 137 | </table> |
0fbeb4dc AK |
138 | <hr/><h2>Define Documentation</h2> |
139 | <a class="anchor" id="gadfa882b6e42a3a993d12392d55260b00"></a><!-- doxytag: member="yaml.h::YAML_NULL_TAG" ref="gadfa882b6e42a3a993d12392d55260b00" args="" --> | |
5c706339 AK |
140 | <div class="memitem"> |
141 | <div class="memproto"> | |
142 | <table class="memname"> | |
143 | <tr> | |
059850b5 | 144 | <td class="memname">#define <a class="el" href="group__nodes.html#gadfa882b6e42a3a993d12392d55260b00">YAML_NULL_TAG</a>   "tag:yaml.org,2002:null"</td> |
5c706339 AK |
145 | </tr> |
146 | </table> | |
147 | </div> | |
148 | <div class="memdoc"> | |
149 | ||
0fbeb4dc | 150 | <p>The tag <code>!!null</code> with the only possible value: <code>null</code>. </p> |
5c706339 AK |
151 | |
152 | </div> | |
0fbeb4dc AK |
153 | </div> |
154 | <a class="anchor" id="ga312629a1f51e91b136352db988d4d771"></a><!-- doxytag: member="yaml.h::YAML_BOOL_TAG" ref="ga312629a1f51e91b136352db988d4d771" args="" --> | |
5c706339 AK |
155 | <div class="memitem"> |
156 | <div class="memproto"> | |
157 | <table class="memname"> | |
158 | <tr> | |
059850b5 | 159 | <td class="memname">#define <a class="el" href="group__nodes.html#ga312629a1f51e91b136352db988d4d771">YAML_BOOL_TAG</a>   "tag:yaml.org,2002:bool"</td> |
5c706339 AK |
160 | </tr> |
161 | </table> | |
162 | </div> | |
163 | <div class="memdoc"> | |
164 | ||
0fbeb4dc | 165 | <p>The tag <code>!!bool</code> with the values: <code>true</code> and <code>falce</code>. </p> |
5c706339 AK |
166 | |
167 | </div> | |
0fbeb4dc AK |
168 | </div> |
169 | <a class="anchor" id="gac5dbc6d1f556663edf8db88d6113e931"></a><!-- doxytag: member="yaml.h::YAML_STR_TAG" ref="gac5dbc6d1f556663edf8db88d6113e931" args="" --> | |
5c706339 AK |
170 | <div class="memitem"> |
171 | <div class="memproto"> | |
172 | <table class="memname"> | |
173 | <tr> | |
059850b5 | 174 | <td class="memname">#define <a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a>   "tag:yaml.org,2002:str"</td> |
5c706339 AK |
175 | </tr> |
176 | </table> | |
177 | </div> | |
178 | <div class="memdoc"> | |
179 | ||
0fbeb4dc | 180 | <p>The tag <code>!!str</code> for string values. </p> |
5c706339 AK |
181 | |
182 | </div> | |
0fbeb4dc AK |
183 | </div> |
184 | <a class="anchor" id="ga83263cdb4ffa6ad2f7d9a87281979ff5"></a><!-- doxytag: member="yaml.h::YAML_INT_TAG" ref="ga83263cdb4ffa6ad2f7d9a87281979ff5" args="" --> | |
5c706339 AK |
185 | <div class="memitem"> |
186 | <div class="memproto"> | |
187 | <table class="memname"> | |
188 | <tr> | |
059850b5 | 189 | <td class="memname">#define <a class="el" href="group__nodes.html#ga83263cdb4ffa6ad2f7d9a87281979ff5">YAML_INT_TAG</a>   "tag:yaml.org,2002:int"</td> |
5c706339 AK |
190 | </tr> |
191 | </table> | |
192 | </div> | |
193 | <div class="memdoc"> | |
194 | ||
0fbeb4dc | 195 | <p>The tag <code>!!int</code> for integer values. </p> |
5c706339 AK |
196 | |
197 | </div> | |
0fbeb4dc AK |
198 | </div> |
199 | <a class="anchor" id="ga6ab2ec71fc47cb24f1003b9acdb92843"></a><!-- doxytag: member="yaml.h::YAML_FLOAT_TAG" ref="ga6ab2ec71fc47cb24f1003b9acdb92843" args="" --> | |
5c706339 AK |
200 | <div class="memitem"> |
201 | <div class="memproto"> | |
202 | <table class="memname"> | |
203 | <tr> | |
059850b5 | 204 | <td class="memname">#define <a class="el" href="group__nodes.html#ga6ab2ec71fc47cb24f1003b9acdb92843">YAML_FLOAT_TAG</a>   "tag:yaml.org,2002:float"</td> |
5c706339 AK |
205 | </tr> |
206 | </table> | |
207 | </div> | |
208 | <div class="memdoc"> | |
209 | ||
0fbeb4dc | 210 | <p>The tag <code>!!float</code> for float values. </p> |
5c706339 AK |
211 | |
212 | </div> | |
0fbeb4dc AK |
213 | </div> |
214 | <a class="anchor" id="ga3e27cca7191234f2e8c95eaf3bc99a73"></a><!-- doxytag: member="yaml.h::YAML_TIMESTAMP_TAG" ref="ga3e27cca7191234f2e8c95eaf3bc99a73" args="" --> | |
5c706339 AK |
215 | <div class="memitem"> |
216 | <div class="memproto"> | |
217 | <table class="memname"> | |
218 | <tr> | |
059850b5 | 219 | <td class="memname">#define <a class="el" href="group__nodes.html#ga3e27cca7191234f2e8c95eaf3bc99a73">YAML_TIMESTAMP_TAG</a>   "tag:yaml.org,2002:timestamp"</td> |
5c706339 AK |
220 | </tr> |
221 | </table> | |
222 | </div> | |
223 | <div class="memdoc"> | |
224 | ||
0fbeb4dc | 225 | <p>The tag <code>!!timestamp</code> for date and time values. </p> |
5c706339 AK |
226 | |
227 | </div> | |
0fbeb4dc AK |
228 | </div> |
229 | <a class="anchor" id="gaa8284b30f9c9e3f10f6a69c9b882f417"></a><!-- doxytag: member="yaml.h::YAML_SEQ_TAG" ref="gaa8284b30f9c9e3f10f6a69c9b882f417" args="" --> | |
5c706339 AK |
230 | <div class="memitem"> |
231 | <div class="memproto"> | |
232 | <table class="memname"> | |
233 | <tr> | |
059850b5 | 234 | <td class="memname">#define <a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a>   "tag:yaml.org,2002:seq"</td> |
5c706339 AK |
235 | </tr> |
236 | </table> | |
237 | </div> | |
238 | <div class="memdoc"> | |
239 | ||
0fbeb4dc | 240 | <p>The tag <code>!!seq</code> is used to denote sequences. </p> |
5c706339 AK |
241 | |
242 | </div> | |
0fbeb4dc AK |
243 | </div> |
244 | <a class="anchor" id="ga22ae99cf3ac014dd76873268fd068c12"></a><!-- doxytag: member="yaml.h::YAML_MAP_TAG" ref="ga22ae99cf3ac014dd76873268fd068c12" args="" --> | |
5c706339 AK |
245 | <div class="memitem"> |
246 | <div class="memproto"> | |
247 | <table class="memname"> | |
248 | <tr> | |
059850b5 | 249 | <td class="memname">#define <a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a>   "tag:yaml.org,2002:map"</td> |
5c706339 AK |
250 | </tr> |
251 | </table> | |
252 | </div> | |
253 | <div class="memdoc"> | |
254 | ||
0fbeb4dc | 255 | <p>The tag <code>!!map</code> is used to denote mapping. </p> |
5c706339 AK |
256 | |
257 | </div> | |
0fbeb4dc AK |
258 | </div> |
259 | <a class="anchor" id="gaf6b0c4e819b8f6915515a4f70065aaaa"></a><!-- doxytag: member="yaml.h::YAML_DEFAULT_SCALAR_TAG" ref="gaf6b0c4e819b8f6915515a4f70065aaaa" args="" --> | |
5c706339 AK |
260 | <div class="memitem"> |
261 | <div class="memproto"> | |
262 | <table class="memname"> | |
263 | <tr> | |
059850b5 | 264 | <td class="memname">#define <a class="el" href="group__nodes.html#gaf6b0c4e819b8f6915515a4f70065aaaa">YAML_DEFAULT_SCALAR_TAG</a>   <a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a></td> |
5c706339 AK |
265 | </tr> |
266 | </table> | |
267 | </div> | |
268 | <div class="memdoc"> | |
269 | ||
0fbeb4dc | 270 | <p>The default scalar tag is <code>!!str</code>. </p> |
5c706339 AK |
271 | |
272 | </div> | |
0fbeb4dc AK |
273 | </div> |
274 | <a class="anchor" id="gaf195b67002518702e27746d6b4da6124"></a><!-- doxytag: member="yaml.h::YAML_DEFAULT_SEQUENCE_TAG" ref="gaf195b67002518702e27746d6b4da6124" args="" --> | |
5c706339 AK |
275 | <div class="memitem"> |
276 | <div class="memproto"> | |
277 | <table class="memname"> | |
278 | <tr> | |
059850b5 | 279 | <td class="memname">#define <a class="el" href="group__nodes.html#gaf195b67002518702e27746d6b4da6124">YAML_DEFAULT_SEQUENCE_TAG</a>   <a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a></td> |
5c706339 AK |
280 | </tr> |
281 | </table> | |
282 | </div> | |
283 | <div class="memdoc"> | |
284 | ||
0fbeb4dc | 285 | <p>The default sequence tag is <code>!!seq</code>. </p> |
5c706339 AK |
286 | |
287 | </div> | |
0fbeb4dc AK |
288 | </div> |
289 | <a class="anchor" id="gaf7b1f8f0ce5665794510cd3841802a5f"></a><!-- doxytag: member="yaml.h::YAML_DEFAULT_MAPPING_TAG" ref="gaf7b1f8f0ce5665794510cd3841802a5f" args="" --> | |
5c706339 AK |
290 | <div class="memitem"> |
291 | <div class="memproto"> | |
292 | <table class="memname"> | |
293 | <tr> | |
059850b5 | 294 | <td class="memname">#define <a class="el" href="group__nodes.html#gaf7b1f8f0ce5665794510cd3841802a5f">YAML_DEFAULT_MAPPING_TAG</a>   <a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a></td> |
5c706339 AK |
295 | </tr> |
296 | </table> | |
297 | </div> | |
298 | <div class="memdoc"> | |
299 | ||
0fbeb4dc | 300 | <p>The default mapping tag is <code>!!map</code>. </p> |
5c706339 AK |
301 | |
302 | </div> | |
0fbeb4dc AK |
303 | </div> |
304 | <hr/><h2>Typedef Documentation</h2> | |
305 | <a class="anchor" id="gabe020d2fc42d3e896549e9f97da622d2"></a><!-- doxytag: member="yaml.h::yaml_node_type_t" ref="gabe020d2fc42d3e896549e9f97da622d2" args="" --> | |
5c706339 AK |
306 | <div class="memitem"> |
307 | <div class="memproto"> | |
308 | <table class="memname"> | |
309 | <tr> | |
0fbeb4dc | 310 | <td class="memname">typedef enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> <a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td> |
5c706339 AK |
311 | </tr> |
312 | </table> | |
313 | </div> | |
314 | <div class="memdoc"> | |
315 | ||
0fbeb4dc | 316 | <p>Node types. </p> |
5c706339 AK |
317 | |
318 | </div> | |
0fbeb4dc AK |
319 | </div> |
320 | <a class="anchor" id="ga9eaaa233b120b9d9db47de93c294c40f"></a><!-- doxytag: member="yaml.h::yaml_node_t" ref="ga9eaaa233b120b9d9db47de93c294c40f" args="" --> | |
5c706339 AK |
321 | <div class="memitem"> |
322 | <div class="memproto"> | |
323 | <table class="memname"> | |
324 | <tr> | |
059850b5 | 325 | <td class="memname">typedef struct <a class="el" href="structyaml__node__s.html">yaml_node_s</a> <a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a></td> |
5c706339 AK |
326 | </tr> |
327 | </table> | |
328 | </div> | |
329 | <div class="memdoc"> | |
330 | ||
0fbeb4dc | 331 | <p>The forward definition of a document node structure. </p> |
5c706339 AK |
332 | |
333 | </div> | |
0fbeb4dc AK |
334 | </div> |
335 | <a class="anchor" id="ga7cc3581582e778b00c04e99cd3656860"></a><!-- doxytag: member="yaml.h::yaml_node_item_t" ref="ga7cc3581582e778b00c04e99cd3656860" args="" --> | |
5c706339 AK |
336 | <div class="memitem"> |
337 | <div class="memproto"> | |
338 | <table class="memname"> | |
339 | <tr> | |
0fbeb4dc | 340 | <td class="memname">typedef int <a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a></td> |
5c706339 AK |
341 | </tr> |
342 | </table> | |
343 | </div> | |
344 | <div class="memdoc"> | |
345 | ||
0fbeb4dc | 346 | <p>An element of a sequence node. </p> |
5c706339 AK |
347 | |
348 | </div> | |
0fbeb4dc AK |
349 | </div> |
350 | <a class="anchor" id="ga90f1c8b83c5c38dc4016afc1cc2050c4"></a><!-- doxytag: member="yaml.h::yaml_node_pair_t" ref="ga90f1c8b83c5c38dc4016afc1cc2050c4" args="" --> | |
5c706339 AK |
351 | <div class="memitem"> |
352 | <div class="memproto"> | |
353 | <table class="memname"> | |
354 | <tr> | |
059850b5 | 355 | <td class="memname">typedef struct <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a> <a class="el" href="group__nodes.html#ga90f1c8b83c5c38dc4016afc1cc2050c4">yaml_node_pair_t</a></td> |
5c706339 AK |
356 | </tr> |
357 | </table> | |
358 | </div> | |
359 | <div class="memdoc"> | |
360 | ||
0fbeb4dc | 361 | <p>An element of a mapping node. </p> |
5c706339 AK |
362 | |
363 | </div> | |
0fbeb4dc AK |
364 | </div> |
365 | <a class="anchor" id="gad94e064e95baeb22e4f7acc7804e8479"></a><!-- doxytag: member="yaml.h::yaml_document_t" ref="gad94e064e95baeb22e4f7acc7804e8479" args="" --> | |
5c706339 AK |
366 | <div class="memitem"> |
367 | <div class="memproto"> | |
368 | <table class="memname"> | |
369 | <tr> | |
059850b5 | 370 | <td class="memname">typedef struct <a class="el" href="structyaml__document__s.html">yaml_document_s</a> <a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a></td> |
5c706339 AK |
371 | </tr> |
372 | </table> | |
373 | </div> | |
374 | <div class="memdoc"> | |
375 | ||
0fbeb4dc | 376 | <p>The document structure. </p> |
5c706339 AK |
377 | |
378 | </div> | |
0fbeb4dc AK |
379 | </div> |
380 | <hr/><h2>Enumeration Type Documentation</h2> | |
381 | <a class="anchor" id="ga0897d4b6bdd1b56c7a5fa0ff17b4f798"></a><!-- doxytag: member="yaml.h::yaml_node_type_e" ref="ga0897d4b6bdd1b56c7a5fa0ff17b4f798" args="" --> | |
b9668ba4 AK |
382 | <div class="memitem"> |
383 | <div class="memproto"> | |
384 | <table class="memname"> | |
385 | <tr> | |
0fbeb4dc | 386 | <td class="memname">enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a></td> |
b9668ba4 AK |
387 | </tr> |
388 | </table> | |
389 | </div> | |
390 | <div class="memdoc"> | |
391 | ||
0fbeb4dc AK |
392 | <p>Node types. </p> |
393 | <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> | |
394 | <tr><td valign="top"><em><a class="anchor" id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739"></a><!-- doxytag: member="YAML_NO_NODE" ref="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739" args="" -->YAML_NO_NODE</em> </td><td> | |
395 | <p>An empty node. </p> | |
5c706339 | 396 | </td></tr> |
0fbeb4dc AK |
397 | <tr><td valign="top"><em><a class="anchor" id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45"></a><!-- doxytag: member="YAML_SCALAR_NODE" ref="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45" args="" -->YAML_SCALAR_NODE</em> </td><td> |
398 | <p>A scalar node. </p> | |
5c706339 | 399 | </td></tr> |
0fbeb4dc AK |
400 | <tr><td valign="top"><em><a class="anchor" id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15"></a><!-- doxytag: member="YAML_SEQUENCE_NODE" ref="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15" args="" -->YAML_SEQUENCE_NODE</em> </td><td> |
401 | <p>A sequence node. </p> | |
5c706339 | 402 | </td></tr> |
0fbeb4dc AK |
403 | <tr><td valign="top"><em><a class="anchor" id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6"></a><!-- doxytag: member="YAML_MAPPING_NODE" ref="gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6" args="" -->YAML_MAPPING_NODE</em> </td><td> |
404 | <p>A mapping node. </p> | |
5c706339 | 405 | </td></tr> |
b9668ba4 | 406 | </table> |
0fbeb4dc | 407 | </dd> |
b9668ba4 AK |
408 | </dl> |
409 | ||
410 | </div> | |
0fbeb4dc AK |
411 | </div> |
412 | <hr/><h2>Function Documentation</h2> | |
413 | <a class="anchor" id="ga62a485c96f3b7962436a0da5e6f3cc89"></a><!-- doxytag: member="yaml.h::yaml_document_initialize" ref="ga62a485c96f3b7962436a0da5e6f3cc89" args="(yaml_document_t *document, yaml_version_directive_t *version_directive, yaml_tag_directive_t *tag_directives_start, yaml_tag_directive_t *tag_directives_end, int start_implicit, int end_implicit)" --> | |
b9668ba4 AK |
414 | <div class="memitem"> |
415 | <div class="memproto"> | |
416 | <table class="memname"> | |
417 | <tr> | |
059850b5 | 418 | <td class="memname">int <a class="el" href="group__nodes.html#ga62a485c96f3b7962436a0da5e6f3cc89">yaml_document_initialize</a> </td> |
b9668ba4 | 419 | <td>(</td> |
059850b5 AK |
420 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
421 | <td class="paramname"><em>document</em>, </td> | |
b9668ba4 AK |
422 | </tr> |
423 | <tr> | |
424 | <td class="paramkey"></td> | |
425 | <td></td> | |
059850b5 AK |
426 | <td class="paramtype"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> * </td> |
427 | <td class="paramname"><em>version_directive</em>, </td> | |
b9668ba4 AK |
428 | </tr> |
429 | <tr> | |
430 | <td class="paramkey"></td> | |
431 | <td></td> | |
059850b5 AK |
432 | <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> * </td> |
433 | <td class="paramname"><em>tag_directives_start</em>, </td> | |
b9668ba4 AK |
434 | </tr> |
435 | <tr> | |
436 | <td class="paramkey"></td> | |
437 | <td></td> | |
059850b5 AK |
438 | <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> * </td> |
439 | <td class="paramname"><em>tag_directives_end</em>, </td> | |
b9668ba4 AK |
440 | </tr> |
441 | <tr> | |
442 | <td class="paramkey"></td> | |
443 | <td></td> | |
059850b5 AK |
444 | <td class="paramtype">int </td> |
445 | <td class="paramname"><em>start_implicit</em>, </td> | |
b9668ba4 AK |
446 | </tr> |
447 | <tr> | |
448 | <td class="paramkey"></td> | |
449 | <td></td> | |
059850b5 AK |
450 | <td class="paramtype">int </td> |
451 | <td class="paramname"><em>end_implicit</em> </td> | |
b9668ba4 AK |
452 | </tr> |
453 | <tr> | |
454 | <td></td> | |
455 | <td>)</td> | |
059850b5 | 456 | <td></td><td></td> |
b9668ba4 AK |
457 | </tr> |
458 | </table> | |
459 | </div> | |
460 | <div class="memdoc"> | |
461 | ||
0fbeb4dc | 462 | <p>Create a YAML document. </p> |
059850b5 AK |
463 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
464 | <table class="params"> | |
465 | <tr><td class="paramdir">[out]</td><td class="paramname">document</td><td>An empty document object. </td></tr> | |
466 | <tr><td class="paramdir">[in]</td><td class="paramname">version_directive</td><td>The YAML directive value or <code>NULL</code>. </td></tr> | |
467 | <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_start</td><td>The beginning of the TAG directives list. </td></tr> | |
468 | <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_end</td><td>The end of the TAG directives list. </td></tr> | |
469 | <tr><td class="paramdir">[in]</td><td class="paramname">start_implicit</td><td>If the document start indicator is implicit. </td></tr> | |
470 | <tr><td class="paramdir">[in]</td><td class="paramname">end_implicit</td><td>If the document end indicator is implicit.</td></tr> | |
b9668ba4 | 471 | </table> |
0fbeb4dc | 472 | </dd> |
b9668ba4 | 473 | </dl> |
0fbeb4dc | 474 | <dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
475 | |
476 | </div> | |
0fbeb4dc AK |
477 | </div> |
478 | <a class="anchor" id="ga2754b1544fb4e110e83fafbc708b0672"></a><!-- doxytag: member="yaml.h::yaml_document_delete" ref="ga2754b1544fb4e110e83fafbc708b0672" args="(yaml_document_t *document)" --> | |
b9668ba4 AK |
479 | <div class="memitem"> |
480 | <div class="memproto"> | |
481 | <table class="memname"> | |
482 | <tr> | |
059850b5 | 483 | <td class="memname">void <a class="el" href="group__nodes.html#ga2754b1544fb4e110e83fafbc708b0672">yaml_document_delete</a> </td> |
b9668ba4 | 484 | <td>(</td> |
059850b5 AK |
485 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
486 | <td class="paramname"><em>document</em></td><td>)</td> | |
5c706339 | 487 | <td></td> |
b9668ba4 AK |
488 | </tr> |
489 | </table> | |
490 | </div> | |
491 | <div class="memdoc"> | |
492 | ||
0fbeb4dc | 493 | <p>Delete a YAML document and all its nodes. </p> |
059850b5 AK |
494 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
495 | <table class="params"> | |
496 | <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr> | |
b9668ba4 | 497 | </table> |
0fbeb4dc | 498 | </dd> |
b9668ba4 AK |
499 | </dl> |
500 | ||
501 | </div> | |
0fbeb4dc AK |
502 | </div> |
503 | <a class="anchor" id="gafa1feabc9747dbded4dca24e27d3c21a"></a><!-- doxytag: member="yaml.h::yaml_document_get_node" ref="gafa1feabc9747dbded4dca24e27d3c21a" args="(yaml_document_t *document, int index)" --> | |
b9668ba4 AK |
504 | <div class="memitem"> |
505 | <div class="memproto"> | |
506 | <table class="memname"> | |
507 | <tr> | |
059850b5 | 508 | <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* <a class="el" href="group__nodes.html#gafa1feabc9747dbded4dca24e27d3c21a">yaml_document_get_node</a> </td> |
b9668ba4 | 509 | <td>(</td> |
059850b5 AK |
510 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
511 | <td class="paramname"><em>document</em>, </td> | |
b9668ba4 AK |
512 | </tr> |
513 | <tr> | |
514 | <td class="paramkey"></td> | |
515 | <td></td> | |
059850b5 AK |
516 | <td class="paramtype">int </td> |
517 | <td class="paramname"><em>index</em> </td> | |
b9668ba4 AK |
518 | </tr> |
519 | <tr> | |
520 | <td></td> | |
521 | <td>)</td> | |
059850b5 | 522 | <td></td><td></td> |
b9668ba4 AK |
523 | </tr> |
524 | </table> | |
525 | </div> | |
526 | <div class="memdoc"> | |
527 | ||
0fbeb4dc AK |
528 | <p>Get a node of a YAML document. </p> |
529 | <p>The pointer returned by this function is valid until any of the functions modifying the documents are called.</p> | |
059850b5 AK |
530 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
531 | <table class="params"> | |
532 | <tr><td class="paramdir">[in]</td><td class="paramname">document</td><td>A document object. </td></tr> | |
533 | <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The node id.</td></tr> | |
b9668ba4 | 534 | </table> |
0fbeb4dc | 535 | </dd> |
b9668ba4 | 536 | </dl> |
0fbeb4dc | 537 | <dl class="return"><dt><b>Returns:</b></dt><dd>the node objct or <code>NULL</code> if <code>node_id</code> is out of range. </dd></dl> |
b9668ba4 AK |
538 | |
539 | </div> | |
0fbeb4dc AK |
540 | </div> |
541 | <a class="anchor" id="ga40eeaa68fb2f3be34c4fe34e7597d324"></a><!-- doxytag: member="yaml.h::yaml_document_get_root_node" ref="ga40eeaa68fb2f3be34c4fe34e7597d324" args="(yaml_document_t *document)" --> | |
b9668ba4 AK |
542 | <div class="memitem"> |
543 | <div class="memproto"> | |
544 | <table class="memname"> | |
545 | <tr> | |
059850b5 | 546 | <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* <a class="el" href="group__nodes.html#ga40eeaa68fb2f3be34c4fe34e7597d324">yaml_document_get_root_node</a> </td> |
b9668ba4 | 547 | <td>(</td> |
059850b5 AK |
548 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
549 | <td class="paramname"><em>document</em></td><td>)</td> | |
5c706339 | 550 | <td></td> |
b9668ba4 AK |
551 | </tr> |
552 | </table> | |
553 | </div> | |
554 | <div class="memdoc"> | |
555 | ||
0fbeb4dc AK |
556 | <p>Get the root of a YAML document node. </p> |
557 | <p>The root object is the first object added to the document.</p> | |
558 | <p>The pointer returned by this function is valid until any of the functions modifying the documents are called.</p> | |
559 | <p>An empty document produced by the parser signifies the end of a YAML stream.</p> | |
059850b5 AK |
560 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
561 | <table class="params"> | |
562 | <tr><td class="paramdir">[in]</td><td class="paramname">document</td><td>A document object.</td></tr> | |
b9668ba4 | 563 | </table> |
0fbeb4dc | 564 | </dd> |
b9668ba4 | 565 | </dl> |
0fbeb4dc | 566 | <dl class="return"><dt><b>Returns:</b></dt><dd>the node object or <code>NULL</code> if the document is empty. </dd></dl> |
b9668ba4 AK |
567 | |
568 | </div> | |
0fbeb4dc AK |
569 | </div> |
570 | <a class="anchor" id="ga45dab8b983b58a005557d4b01f5057b0"></a><!-- doxytag: member="yaml.h::yaml_document_add_scalar" ref="ga45dab8b983b58a005557d4b01f5057b0" args="(yaml_document_t *document, yaml_char_t *tag, yaml_char_t *value, int length, yaml_scalar_style_t style)" --> | |
b9668ba4 AK |
571 | <div class="memitem"> |
572 | <div class="memproto"> | |
573 | <table class="memname"> | |
574 | <tr> | |
059850b5 | 575 | <td class="memname">int <a class="el" href="group__nodes.html#ga45dab8b983b58a005557d4b01f5057b0">yaml_document_add_scalar</a> </td> |
b9668ba4 | 576 | <td>(</td> |
059850b5 AK |
577 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
578 | <td class="paramname"><em>document</em>, </td> | |
b9668ba4 AK |
579 | </tr> |
580 | <tr> | |
581 | <td class="paramkey"></td> | |
582 | <td></td> | |
059850b5 AK |
583 | <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> |
584 | <td class="paramname"><em>tag</em>, </td> | |
b9668ba4 AK |
585 | </tr> |
586 | <tr> | |
587 | <td class="paramkey"></td> | |
588 | <td></td> | |
059850b5 AK |
589 | <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> |
590 | <td class="paramname"><em>value</em>, </td> | |
b9668ba4 AK |
591 | </tr> |
592 | <tr> | |
593 | <td class="paramkey"></td> | |
594 | <td></td> | |
059850b5 AK |
595 | <td class="paramtype">int </td> |
596 | <td class="paramname"><em>length</em>, </td> | |
b9668ba4 AK |
597 | </tr> |
598 | <tr> | |
599 | <td class="paramkey"></td> | |
600 | <td></td> | |
059850b5 AK |
601 | <td class="paramtype"><a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> </td> |
602 | <td class="paramname"><em>style</em> </td> | |
b9668ba4 AK |
603 | </tr> |
604 | <tr> | |
605 | <td></td> | |
606 | <td>)</td> | |
059850b5 | 607 | <td></td><td></td> |
b9668ba4 AK |
608 | </tr> |
609 | </table> | |
610 | </div> | |
611 | <div class="memdoc"> | |
612 | ||
0fbeb4dc AK |
613 | <p>Create a SCALAR node and attach it to the document. </p> |
614 | <p>The <em>style</em> argument may be ignored by the emitter.</p> | |
059850b5 AK |
615 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
616 | <table class="params"> | |
617 | <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr> | |
618 | <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The scalar tag. </td></tr> | |
619 | <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The scalar value. </td></tr> | |
620 | <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the scalar value. </td></tr> | |
621 | <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The scalar style.</td></tr> | |
b9668ba4 | 622 | </table> |
0fbeb4dc | 623 | </dd> |
b9668ba4 | 624 | </dl> |
0fbeb4dc | 625 | <dl class="return"><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
626 | |
627 | </div> | |
0fbeb4dc AK |
628 | </div> |
629 | <a class="anchor" id="ga83b2f7fdd9a439397a42016bddad7786"></a><!-- doxytag: member="yaml.h::yaml_document_add_sequence" ref="ga83b2f7fdd9a439397a42016bddad7786" args="(yaml_document_t *document, yaml_char_t *tag, yaml_sequence_style_t style)" --> | |
b9668ba4 AK |
630 | <div class="memitem"> |
631 | <div class="memproto"> | |
632 | <table class="memname"> | |
633 | <tr> | |
059850b5 | 634 | <td class="memname">int <a class="el" href="group__nodes.html#ga83b2f7fdd9a439397a42016bddad7786">yaml_document_add_sequence</a> </td> |
b9668ba4 | 635 | <td>(</td> |
059850b5 AK |
636 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
637 | <td class="paramname"><em>document</em>, </td> | |
b9668ba4 AK |
638 | </tr> |
639 | <tr> | |
640 | <td class="paramkey"></td> | |
641 | <td></td> | |
059850b5 AK |
642 | <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> |
643 | <td class="paramname"><em>tag</em>, </td> | |
b9668ba4 AK |
644 | </tr> |
645 | <tr> | |
646 | <td class="paramkey"></td> | |
647 | <td></td> | |
059850b5 AK |
648 | <td class="paramtype"><a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> </td> |
649 | <td class="paramname"><em>style</em> </td> | |
b9668ba4 AK |
650 | </tr> |
651 | <tr> | |
652 | <td></td> | |
653 | <td>)</td> | |
059850b5 | 654 | <td></td><td></td> |
b9668ba4 AK |
655 | </tr> |
656 | </table> | |
657 | </div> | |
658 | <div class="memdoc"> | |
659 | ||
0fbeb4dc AK |
660 | <p>Create a SEQUENCE node and attach it to the document. </p> |
661 | <p>The <em>style</em> argument may be ignored by the emitter.</p> | |
059850b5 AK |
662 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
663 | <table class="params"> | |
664 | <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr> | |
665 | <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag. </td></tr> | |
666 | <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr> | |
b9668ba4 | 667 | </table> |
0fbeb4dc | 668 | </dd> |
b9668ba4 | 669 | </dl> |
0fbeb4dc | 670 | <dl class="return"><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
671 | |
672 | </div> | |
0fbeb4dc AK |
673 | </div> |
674 | <a class="anchor" id="ga45a9f8288704f99cd81dc5cb31329d34"></a><!-- doxytag: member="yaml.h::yaml_document_add_mapping" ref="ga45a9f8288704f99cd81dc5cb31329d34" args="(yaml_document_t *document, yaml_char_t *tag, yaml_mapping_style_t style)" --> | |
b9668ba4 AK |
675 | <div class="memitem"> |
676 | <div class="memproto"> | |
677 | <table class="memname"> | |
678 | <tr> | |
059850b5 | 679 | <td class="memname">int <a class="el" href="group__nodes.html#ga45a9f8288704f99cd81dc5cb31329d34">yaml_document_add_mapping</a> </td> |
b9668ba4 | 680 | <td>(</td> |
059850b5 AK |
681 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
682 | <td class="paramname"><em>document</em>, </td> | |
b9668ba4 AK |
683 | </tr> |
684 | <tr> | |
685 | <td class="paramkey"></td> | |
686 | <td></td> | |
059850b5 AK |
687 | <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> |
688 | <td class="paramname"><em>tag</em>, </td> | |
b9668ba4 AK |
689 | </tr> |
690 | <tr> | |
691 | <td class="paramkey"></td> | |
692 | <td></td> | |
059850b5 AK |
693 | <td class="paramtype"><a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> </td> |
694 | <td class="paramname"><em>style</em> </td> | |
b9668ba4 AK |
695 | </tr> |
696 | <tr> | |
697 | <td></td> | |
698 | <td>)</td> | |
059850b5 | 699 | <td></td><td></td> |
b9668ba4 AK |
700 | </tr> |
701 | </table> | |
702 | </div> | |
703 | <div class="memdoc"> | |
704 | ||
0fbeb4dc AK |
705 | <p>Create a MAPPING node and attach it to the document. </p> |
706 | <p>The <em>style</em> argument may be ignored by the emitter.</p> | |
059850b5 AK |
707 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
708 | <table class="params"> | |
709 | <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr> | |
710 | <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag. </td></tr> | |
711 | <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr> | |
b9668ba4 | 712 | </table> |
0fbeb4dc | 713 | </dd> |
b9668ba4 | 714 | </dl> |
0fbeb4dc | 715 | <dl class="return"><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
716 | |
717 | </div> | |
0fbeb4dc AK |
718 | </div> |
719 | <a class="anchor" id="ga16435917cd6c0261cd390fa8cf173b1b"></a><!-- doxytag: member="yaml.h::yaml_document_append_sequence_item" ref="ga16435917cd6c0261cd390fa8cf173b1b" args="(yaml_document_t *document, int sequence, int item)" --> | |
b9668ba4 AK |
720 | <div class="memitem"> |
721 | <div class="memproto"> | |
722 | <table class="memname"> | |
723 | <tr> | |
059850b5 | 724 | <td class="memname">int <a class="el" href="group__nodes.html#ga16435917cd6c0261cd390fa8cf173b1b">yaml_document_append_sequence_item</a> </td> |
b9668ba4 | 725 | <td>(</td> |
059850b5 AK |
726 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
727 | <td class="paramname"><em>document</em>, </td> | |
b9668ba4 AK |
728 | </tr> |
729 | <tr> | |
730 | <td class="paramkey"></td> | |
731 | <td></td> | |
059850b5 AK |
732 | <td class="paramtype">int </td> |
733 | <td class="paramname"><em>sequence</em>, </td> | |
b9668ba4 AK |
734 | </tr> |
735 | <tr> | |
736 | <td class="paramkey"></td> | |
737 | <td></td> | |
059850b5 AK |
738 | <td class="paramtype">int </td> |
739 | <td class="paramname"><em>item</em> </td> | |
b9668ba4 AK |
740 | </tr> |
741 | <tr> | |
742 | <td></td> | |
743 | <td>)</td> | |
059850b5 | 744 | <td></td><td></td> |
b9668ba4 AK |
745 | </tr> |
746 | </table> | |
747 | </div> | |
748 | <div class="memdoc"> | |
749 | ||
0fbeb4dc | 750 | <p>Add an item to a SEQUENCE node. </p> |
059850b5 AK |
751 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
752 | <table class="params"> | |
753 | <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr> | |
754 | <tr><td class="paramdir">[in]</td><td class="paramname">sequence</td><td>The sequence node id. </td></tr> | |
755 | <tr><td class="paramdir">[in]</td><td class="paramname">item</td><td>The item node id.</td></tr> | |
b9668ba4 | 756 | </table> |
0fbeb4dc | 757 | </dd> |
b9668ba4 | 758 | </dl> |
0fbeb4dc | 759 | <dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
760 | |
761 | </div> | |
0fbeb4dc AK |
762 | </div> |
763 | <a class="anchor" id="ga2db27002d8a9ae06b1729d0ee06553d2"></a><!-- doxytag: member="yaml.h::yaml_document_append_mapping_pair" ref="ga2db27002d8a9ae06b1729d0ee06553d2" args="(yaml_document_t *document, int mapping, int key, int value)" --> | |
b9668ba4 AK |
764 | <div class="memitem"> |
765 | <div class="memproto"> | |
766 | <table class="memname"> | |
767 | <tr> | |
059850b5 | 768 | <td class="memname">int <a class="el" href="group__nodes.html#ga2db27002d8a9ae06b1729d0ee06553d2">yaml_document_append_mapping_pair</a> </td> |
b9668ba4 | 769 | <td>(</td> |
059850b5 AK |
770 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
771 | <td class="paramname"><em>document</em>, </td> | |
b9668ba4 AK |
772 | </tr> |
773 | <tr> | |
774 | <td class="paramkey"></td> | |
775 | <td></td> | |
059850b5 AK |
776 | <td class="paramtype">int </td> |
777 | <td class="paramname"><em>mapping</em>, </td> | |
b9668ba4 AK |
778 | </tr> |
779 | <tr> | |
780 | <td class="paramkey"></td> | |
781 | <td></td> | |
059850b5 AK |
782 | <td class="paramtype">int </td> |
783 | <td class="paramname"><em>key</em>, </td> | |
b9668ba4 AK |
784 | </tr> |
785 | <tr> | |
786 | <td class="paramkey"></td> | |
787 | <td></td> | |
059850b5 AK |
788 | <td class="paramtype">int </td> |
789 | <td class="paramname"><em>value</em> </td> | |
b9668ba4 AK |
790 | </tr> |
791 | <tr> | |
792 | <td></td> | |
793 | <td>)</td> | |
059850b5 | 794 | <td></td><td></td> |
b9668ba4 AK |
795 | </tr> |
796 | </table> | |
797 | </div> | |
798 | <div class="memdoc"> | |
799 | ||
0fbeb4dc | 800 | <p>Add a pair of a key and a value to a MAPPING node. </p> |
059850b5 AK |
801 | <dl class="params"><dt><b>Parameters:</b></dt><dd> |
802 | <table class="params"> | |
803 | <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr> | |
804 | <tr><td class="paramdir">[in]</td><td class="paramname">mapping</td><td>The mapping node id. </td></tr> | |
805 | <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>The key node id. </td></tr> | |
806 | <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value node id.</td></tr> | |
b9668ba4 | 807 | </table> |
0fbeb4dc | 808 | </dd> |
b9668ba4 | 809 | </dl> |
0fbeb4dc | 810 | <dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
811 | |
812 | </div> | |
5c706339 | 813 | </div> |
059850b5 AK |
814 | </div><!-- contents --> |
815 | ||
816 | ||
817 | <hr class="footer"/><address class="footer"><small> | |
818 | Generated on Sun Jan 12 2014 18:25:30 for yaml by  <a href="http://www.doxygen.org/index.html"> | |
819 | <img class="footer" src="doxygen.png" alt="doxygen"/> | |
820 | </a> 1.7.6.1 | |
821 | </small></address> | |
822 | ||
b9668ba4 AK |
823 | </body> |
824 | </html> |