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