doc/html/group__nodes.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>yaml: Nodes</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.1 -->
   8 <div class="tabs">
   9   <ul>
  10     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11     <li><a href="modules.html"><span>Modules</span></a></li>
  12     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  13     <li><a href="files.html"><span>Files</span></a></li>
  14   </ul></div>
  15 <h1>Nodes</h1><table border="0" cellpadding="0" cellspacing="0">
  16 <tr><td></td></tr>
  17 <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
  18 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a></td></tr>
  19
  20 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An element of a mapping node.  <a href="structyaml__node__pair__s.html#_details">More...</a><br></td></tr>
  21 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html">yaml_node_s</a></td></tr>
  22
  23 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The node structure.  <a href="structyaml__node__s.html#_details">More...</a><br></td></tr>
  24 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html">yaml_document_s</a></td></tr>
  25
  26 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The document structure.  <a href="structyaml__document__s.html#_details">More...</a><br></td></tr>
  27 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
  28 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdfa882b6e42a3a993d12392d55260b00"></a><!-- doxytag: member="nodes::YAML_NULL_TAG" ref="gdfa882b6e42a3a993d12392d55260b00" args="" -->
  29 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gdfa882b6e42a3a993d12392d55260b00">YAML_NULL_TAG</a>&nbsp;&nbsp;&nbsp;&quot;tag:yaml.org,2002:null&quot;</td></tr>
  30
  31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag <code>!!null</code> with the only possible value: <code>null</code>. <br></td></tr>
  32 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g312629a1f51e91b136352db988d4d771"></a><!-- doxytag: member="nodes::YAML_BOOL_TAG" ref="g312629a1f51e91b136352db988d4d771" args="" -->
  33 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g312629a1f51e91b136352db988d4d771">YAML_BOOL_TAG</a>&nbsp;&nbsp;&nbsp;&quot;tag:yaml.org,2002:bool&quot;</td></tr>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag <code>!!bool</code> with the values: <code>true</code> and <code>falce</code>. <br></td></tr>
  36 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc5dbc6d1f556663edf8db88d6113e931"></a><!-- doxytag: member="nodes::YAML_STR_TAG" ref="gc5dbc6d1f556663edf8db88d6113e931" args="" -->
  37 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gc5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a>&nbsp;&nbsp;&nbsp;&quot;tag:yaml.org,2002:str&quot;</td></tr>
  38
  39 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag <code>!!str</code> for string values. <br></td></tr>
  40 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g83263cdb4ffa6ad2f7d9a87281979ff5"></a><!-- doxytag: member="nodes::YAML_INT_TAG" ref="g83263cdb4ffa6ad2f7d9a87281979ff5" args="" -->
  41 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g83263cdb4ffa6ad2f7d9a87281979ff5">YAML_INT_TAG</a>&nbsp;&nbsp;&nbsp;&quot;tag:yaml.org,2002:int&quot;</td></tr>
  42
  43 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag <code>!!int</code> for integer values. <br></td></tr>
  44 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6ab2ec71fc47cb24f1003b9acdb92843"></a><!-- doxytag: member="nodes::YAML_FLOAT_TAG" ref="g6ab2ec71fc47cb24f1003b9acdb92843" args="" -->
  45 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g6ab2ec71fc47cb24f1003b9acdb92843">YAML_FLOAT_TAG</a>&nbsp;&nbsp;&nbsp;&quot;tag:yaml.org,2002:float&quot;</td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag <code>!!float</code> for float values. <br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3e27cca7191234f2e8c95eaf3bc99a73"></a><!-- doxytag: member="nodes::YAML_TIMESTAMP_TAG" ref="g3e27cca7191234f2e8c95eaf3bc99a73" args="" -->
  49 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g3e27cca7191234f2e8c95eaf3bc99a73">YAML_TIMESTAMP_TAG</a>&nbsp;&nbsp;&nbsp;&quot;tag:yaml.org,2002:timestamp&quot;</td></tr>
  50
  51 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag <code>!!timestamp</code> for date and time values. <br></td></tr>
  52 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga8284b30f9c9e3f10f6a69c9b882f417"></a><!-- doxytag: member="nodes::YAML_SEQ_TAG" ref="ga8284b30f9c9e3f10f6a69c9b882f417" args="" -->
  53 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a>&nbsp;&nbsp;&nbsp;&quot;tag:yaml.org,2002:seq&quot;</td></tr>
  54
  55 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag <code>!!seq</code> is used to denote sequences. <br></td></tr>
  56 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g22ae99cf3ac014dd76873268fd068c12"></a><!-- doxytag: member="nodes::YAML_MAP_TAG" ref="g22ae99cf3ac014dd76873268fd068c12" args="" -->
  57 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a>&nbsp;&nbsp;&nbsp;&quot;tag:yaml.org,2002:map&quot;</td></tr>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tag <code>!!map</code> is used to denote mapping. <br></td></tr>
  60 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf6b0c4e819b8f6915515a4f70065aaaa"></a><!-- doxytag: member="nodes::YAML_DEFAULT_SCALAR_TAG" ref="gf6b0c4e819b8f6915515a4f70065aaaa" args="" -->
  61 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gf6b0c4e819b8f6915515a4f70065aaaa">YAML_DEFAULT_SCALAR_TAG</a>&nbsp;&nbsp;&nbsp;YAML_STR_TAG</td></tr>
  62
  63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default scalar tag is <code>!!str</code>. <br></td></tr>
  64 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf195b67002518702e27746d6b4da6124"></a><!-- doxytag: member="nodes::YAML_DEFAULT_SEQUENCE_TAG" ref="gf195b67002518702e27746d6b4da6124" args="" -->
  65 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gf195b67002518702e27746d6b4da6124">YAML_DEFAULT_SEQUENCE_TAG</a>&nbsp;&nbsp;&nbsp;YAML_SEQ_TAG</td></tr>
  66
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default sequence tag is <code>!!seq</code>. <br></td></tr>
  68 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf7b1f8f0ce5665794510cd3841802a5f"></a><!-- doxytag: member="nodes::YAML_DEFAULT_MAPPING_TAG" ref="gf7b1f8f0ce5665794510cd3841802a5f" args="" -->
  69 #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gf7b1f8f0ce5665794510cd3841802a5f">YAML_DEFAULT_MAPPING_TAG</a>&nbsp;&nbsp;&nbsp;YAML_MAP_TAG</td></tr>
  70
  71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default mapping tag is <code>!!map</code>. <br></td></tr>
  72 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
  73 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbe020d2fc42d3e896549e9f97da622d2"></a><!-- doxytag: member="nodes::yaml_node_type_t" ref="gbe020d2fc42d3e896549e9f97da622d2" args="" -->
  74 typedef enum <a class="el" href="group__nodes.html#g0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gbe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td></tr>
  75
  76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Node types. <br></td></tr>
  77 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9eaaa233b120b9d9db47de93c294c40f"></a><!-- doxytag: member="nodes::yaml_node_t" ref="g9eaaa233b120b9d9db47de93c294c40f" args="" -->
  78 typedef <a class="el" href="structyaml__node__s.html">yaml_node_s</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a></td></tr>
  79
  80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The forward definition of a document node structure. <br></td></tr>
  81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7cc3581582e778b00c04e99cd3656860"></a><!-- doxytag: member="nodes::yaml_node_item_t" ref="g7cc3581582e778b00c04e99cd3656860" args="" -->
  82 typedef int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a></td></tr>
  83
  84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An element of a sequence node. <br></td></tr>
  85 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g90f1c8b83c5c38dc4016afc1cc2050c4"></a><!-- doxytag: member="nodes::yaml_node_pair_t" ref="g90f1c8b83c5c38dc4016afc1cc2050c4" args="" -->
  86 typedef <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g90f1c8b83c5c38dc4016afc1cc2050c4">yaml_node_pair_t</a></td></tr>
  87
  88 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An element of a mapping node. <br></td></tr>
  89 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd94e064e95baeb22e4f7acc7804e8479"></a><!-- doxytag: member="nodes::yaml_document_t" ref="gd94e064e95baeb22e4f7acc7804e8479" args="" -->
  90 typedef <a class="el" href="structyaml__document__s.html">yaml_document_s</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gd94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a></td></tr>
  91
  92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The document structure. <br></td></tr>
  93 <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
  94 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> { <br>
  95 &nbsp;&nbsp;<a class="el" href="group__nodes.html#gg0897d4b6bdd1b56c7a5fa0ff17b4f7980fa87c0e89c4d4136cb47165e6917739">YAML_NO_NODE</a>,
  96 <br>
  97 &nbsp;&nbsp;<a class="el" href="group__nodes.html#gg0897d4b6bdd1b56c7a5fa0ff17b4f798413ec8ce6b728c9ace703d194b370a45">YAML_SCALAR_NODE</a>,
  98 <br>
  99 &nbsp;&nbsp;<a class="el" href="group__nodes.html#gg0897d4b6bdd1b56c7a5fa0ff17b4f7986c03b52f7ee737982eac5e4001faac15">YAML_SEQUENCE_NODE</a>,
 100 <br>
 101 &nbsp;&nbsp;<a class="el" href="group__nodes.html#gg0897d4b6bdd1b56c7a5fa0ff17b4f798c1a08580e3a70973583fc85e3e097ee6">YAML_MAPPING_NODE</a>
 102 <br>
 103  }</td></tr>
 104
 105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Node types.  <a href="group__nodes.html#g0897d4b6bdd1b56c7a5fa0ff17b4f798">More...</a><br></td></tr>
 106 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 107 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g62a485c96f3b7962436a0da5e6f3cc89">yaml_document_initialize</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, <a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> *version_directive, <a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *tag_directives_start, <a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *tag_directives_end, int start_implicit, int end_implicit)</td></tr>
 108
 109 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a YAML document.  <a href="#g62a485c96f3b7962436a0da5e6f3cc89"></a><br></td></tr>
 110 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g2754b1544fb4e110e83fafbc708b0672">yaml_document_delete</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document)</td></tr>
 111
 112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delete a YAML document and all its nodes.  <a href="#g2754b1544fb4e110e83fafbc708b0672"></a><br></td></tr>
 113 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gfa1feabc9747dbded4dca24e27d3c21a">yaml_document_get_node</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, int index)</td></tr>
 114
 115 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a node of a YAML document.  <a href="#gfa1feabc9747dbded4dca24e27d3c21a"></a><br></td></tr>
 116 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g40eeaa68fb2f3be34c4fe34e7597d324">yaml_document_get_root_node</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document)</td></tr>
 117
 118 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the root of a YAML document node.  <a href="#g40eeaa68fb2f3be34c4fe34e7597d324"></a><br></td></tr>
 119 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g45dab8b983b58a005557d4b01f5057b0">yaml_document_add_scalar</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *value, int length, <a class="el" href="group__styles.html#g3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr>
 120
 121 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a SCALAR node and attach it to the document.  <a href="#g45dab8b983b58a005557d4b01f5057b0"></a><br></td></tr>
 122 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g83b2f7fdd9a439397a42016bddad7786">yaml_document_add_sequence</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#g58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr>
 123
 124 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a SEQUENCE node and attach it to the document.  <a href="#g83b2f7fdd9a439397a42016bddad7786"></a><br></td></tr>
 125 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g45a9f8288704f99cd81dc5cb31329d34">yaml_document_add_mapping</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#gb47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr>
 126
 127 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a MAPPING node and attach it to the document.  <a href="#g45a9f8288704f99cd81dc5cb31329d34"></a><br></td></tr>
 128 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g16435917cd6c0261cd390fa8cf173b1b">yaml_document_append_sequence_item</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, int sequence, int item)</td></tr>
 129
 130 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add an item to a SEQUENCE node.  <a href="#g16435917cd6c0261cd390fa8cf173b1b"></a><br></td></tr>
 131 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#g2db27002d8a9ae06b1729d0ee06553d2">yaml_document_append_mapping_pair</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, int mapping, int key, int value)</td></tr>
 132
 133 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a pair of a key and a value to a MAPPING node.  <a href="#g2db27002d8a9ae06b1729d0ee06553d2"></a><br></td></tr>
 134 </table>
 135 <hr><h2>Enumeration Type Documentation</h2>
 136 <a class="anchor" name="g0897d4b6bdd1b56c7a5fa0ff17b4f798"></a><!-- doxytag: member="yaml.h::yaml_node_type_e" ref="g0897d4b6bdd1b56c7a5fa0ff17b4f798" args="" -->
 137 <div class="memitem">
 138 <div class="memproto">
 139       <table class="memname">
 140         <tr>
 141           <td class="memname">enum <a class="el" href="group__nodes.html#g0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a>          </td>
 142         </tr>
 143       </table>
 144 </div>
 145 <div class="memdoc">
 146
 147 <p>
 148 Node types.
 149 <p>
 150 <dl compact><dt><b>Enumerator: </b></dt><dd>
 151 <table border="0" cellspacing="2" cellpadding="0">
 152 <tr><td valign="top"><em><a class="anchor" name="gg0897d4b6bdd1b56c7a5fa0ff17b4f7980fa87c0e89c4d4136cb47165e6917739"></a><!-- doxytag: member="YAML_NO_NODE" ref="gg0897d4b6bdd1b56c7a5fa0ff17b4f7980fa87c0e89c4d4136cb47165e6917739" args="" -->YAML_NO_NODE</em>&nbsp;</td><td>
 153 An empty node. </td></tr>
 154 <tr><td valign="top"><em><a class="anchor" name="gg0897d4b6bdd1b56c7a5fa0ff17b4f798413ec8ce6b728c9ace703d194b370a45"></a><!-- doxytag: member="YAML_SCALAR_NODE" ref="gg0897d4b6bdd1b56c7a5fa0ff17b4f798413ec8ce6b728c9ace703d194b370a45" args="" -->YAML_SCALAR_NODE</em>&nbsp;</td><td>
 155 A scalar node. </td></tr>
 156 <tr><td valign="top"><em><a class="anchor" name="gg0897d4b6bdd1b56c7a5fa0ff17b4f7986c03b52f7ee737982eac5e4001faac15"></a><!-- doxytag: member="YAML_SEQUENCE_NODE" ref="gg0897d4b6bdd1b56c7a5fa0ff17b4f7986c03b52f7ee737982eac5e4001faac15" args="" -->YAML_SEQUENCE_NODE</em>&nbsp;</td><td>
 157 A sequence node. </td></tr>
 158 <tr><td valign="top"><em><a class="anchor" name="gg0897d4b6bdd1b56c7a5fa0ff17b4f798c1a08580e3a70973583fc85e3e097ee6"></a><!-- doxytag: member="YAML_MAPPING_NODE" ref="gg0897d4b6bdd1b56c7a5fa0ff17b4f798c1a08580e3a70973583fc85e3e097ee6" args="" -->YAML_MAPPING_NODE</em>&nbsp;</td><td>
 159 A mapping node. </td></tr>
 160 </table>
 161 </dl>
 162
 163 </div>
 164 </div><p>
 165 <hr><h2>Function Documentation</h2>
 166 <a class="anchor" name="g62a485c96f3b7962436a0da5e6f3cc89"></a><!-- doxytag: member="yaml.h::yaml_document_initialize" ref="g62a485c96f3b7962436a0da5e6f3cc89" 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)" -->
 167 <div class="memitem">
 168 <div class="memproto">
 169       <table class="memname">
 170         <tr>
 171           <td class="memname">int yaml_document_initialize           </td>
 172           <td>(</td>
 173           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 174           <td class="paramname"> <em>document</em>, </td>
 175         </tr>
 176         <tr>
 177           <td class="paramkey"></td>
 178           <td></td>
 179           <td class="paramtype"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> *&nbsp;</td>
 180           <td class="paramname"> <em>version_directive</em>, </td>
 181         </tr>
 182         <tr>
 183           <td class="paramkey"></td>
 184           <td></td>
 185           <td class="paramtype"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;</td>
 186           <td class="paramname"> <em>tag_directives_start</em>, </td>
 187         </tr>
 188         <tr>
 189           <td class="paramkey"></td>
 190           <td></td>
 191           <td class="paramtype"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;</td>
 192           <td class="paramname"> <em>tag_directives_end</em>, </td>
 193         </tr>
 194         <tr>
 195           <td class="paramkey"></td>
 196           <td></td>
 197           <td class="paramtype">int&nbsp;</td>
 198           <td class="paramname"> <em>start_implicit</em>, </td>
 199         </tr>
 200         <tr>
 201           <td class="paramkey"></td>
 202           <td></td>
 203           <td class="paramtype">int&nbsp;</td>
 204           <td class="paramname"> <em>end_implicit</em></td><td>&nbsp;</td>
 205         </tr>
 206         <tr>
 207           <td></td>
 208           <td>)</td>
 209           <td></td><td></td><td width="100%"></td>
 210         </tr>
 211       </table>
 212 </div>
 213 <div class="memdoc">
 214
 215 <p>
 216 Create a YAML document.
 217 <p>
 218 <dl compact><dt><b>Parameters:</b></dt><dd>
 219   <table border="0" cellspacing="2" cellpadding="0">
 220     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>An empty document object. </td></tr>
 221     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>version_directive</em>&nbsp;</td><td>The YAML directive value or <code>NULL</code>. </td></tr>
 222     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>tag_directives_start</em>&nbsp;</td><td>The beginning of the TAG directives list. </td></tr>
 223     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>tag_directives_end</em>&nbsp;</td><td>The end of the TAG directives list. </td></tr>
 224     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>start_implicit</em>&nbsp;</td><td>If the document start indicator is implicit. </td></tr>
 225     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>end_implicit</em>&nbsp;</td><td>If the document end indicator is implicit.</td></tr>
 226   </table>
 227 </dl>
 228 <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 229
 230 </div>
 231 </div><p>
 232 <a class="anchor" name="g2754b1544fb4e110e83fafbc708b0672"></a><!-- doxytag: member="yaml.h::yaml_document_delete" ref="g2754b1544fb4e110e83fafbc708b0672" args="(yaml_document_t *document)" -->
 233 <div class="memitem">
 234 <div class="memproto">
 235       <table class="memname">
 236         <tr>
 237           <td class="memname">void yaml_document_delete           </td>
 238           <td>(</td>
 239           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 240           <td class="paramname"> <em>document</em>          </td>
 241           <td>&nbsp;)&nbsp;</td>
 242           <td width="100%"></td>
 243         </tr>
 244       </table>
 245 </div>
 246 <div class="memdoc">
 247
 248 <p>
 249 Delete a YAML document and all its nodes.
 250 <p>
 251 <dl compact><dt><b>Parameters:</b></dt><dd>
 252   <table border="0" cellspacing="2" cellpadding="0">
 253     <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>A document object. </td></tr>
 254   </table>
 255 </dl>
 256
 257 </div>
 258 </div><p>
 259 <a class="anchor" name="gfa1feabc9747dbded4dca24e27d3c21a"></a><!-- doxytag: member="yaml.h::yaml_document_get_node" ref="gfa1feabc9747dbded4dca24e27d3c21a" args="(yaml_document_t *document, int index)" -->
 260 <div class="memitem">
 261 <div class="memproto">
 262       <table class="memname">
 263         <tr>
 264           <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* yaml_document_get_node           </td>
 265           <td>(</td>
 266           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 267           <td class="paramname"> <em>document</em>, </td>
 268         </tr>
 269         <tr>
 270           <td class="paramkey"></td>
 271           <td></td>
 272           <td class="paramtype">int&nbsp;</td>
 273           <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
 274         </tr>
 275         <tr>
 276           <td></td>
 277           <td>)</td>
 278           <td></td><td></td><td width="100%"></td>
 279         </tr>
 280       </table>
 281 </div>
 282 <div class="memdoc">
 283
 284 <p>
 285 Get a node of a YAML document.
 286 <p>
 287 The pointer returned by this function is valid until any of the functions modifying the documents are called.<p>
 288 <dl compact><dt><b>Parameters:</b></dt><dd>
 289   <table border="0" cellspacing="2" cellpadding="0">
 290     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>A document object. </td></tr>
 291     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>index</em>&nbsp;</td><td>The node id.</td></tr>
 292   </table>
 293 </dl>
 294 <dl class="return" compact><dt><b>Returns:</b></dt><dd>the node objct or <code>NULL</code> if <code>node_id</code> is out of range. </dd></dl>
 295
 296 </div>
 297 </div><p>
 298 <a class="anchor" name="g40eeaa68fb2f3be34c4fe34e7597d324"></a><!-- doxytag: member="yaml.h::yaml_document_get_root_node" ref="g40eeaa68fb2f3be34c4fe34e7597d324" args="(yaml_document_t *document)" -->
 299 <div class="memitem">
 300 <div class="memproto">
 301       <table class="memname">
 302         <tr>
 303           <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* yaml_document_get_root_node           </td>
 304           <td>(</td>
 305           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 306           <td class="paramname"> <em>document</em>          </td>
 307           <td>&nbsp;)&nbsp;</td>
 308           <td width="100%"></td>
 309         </tr>
 310       </table>
 311 </div>
 312 <div class="memdoc">
 313
 314 <p>
 315 Get the root of a YAML document node.
 316 <p>
 317 The root object is the first object added to the document.<p>
 318 The pointer returned by this function is valid until any of the functions modifying the documents are called.<p>
 319 An empty document produced by the parser signifies the end of a YAML stream.<p>
 320 <dl compact><dt><b>Parameters:</b></dt><dd>
 321   <table border="0" cellspacing="2" cellpadding="0">
 322     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>A document object.</td></tr>
 323   </table>
 324 </dl>
 325 <dl class="return" compact><dt><b>Returns:</b></dt><dd>the node object or <code>NULL</code> if the document is empty. </dd></dl>
 326
 327 </div>
 328 </div><p>
 329 <a class="anchor" name="g45dab8b983b58a005557d4b01f5057b0"></a><!-- doxytag: member="yaml.h::yaml_document_add_scalar" ref="g45dab8b983b58a005557d4b01f5057b0" args="(yaml_document_t *document, yaml_char_t *tag, yaml_char_t *value, int length, yaml_scalar_style_t style)" -->
 330 <div class="memitem">
 331 <div class="memproto">
 332       <table class="memname">
 333         <tr>
 334           <td class="memname">int yaml_document_add_scalar           </td>
 335           <td>(</td>
 336           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 337           <td class="paramname"> <em>document</em>, </td>
 338         </tr>
 339         <tr>
 340           <td class="paramkey"></td>
 341           <td></td>
 342           <td class="paramtype"><a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;</td>
 343           <td class="paramname"> <em>tag</em>, </td>
 344         </tr>
 345         <tr>
 346           <td class="paramkey"></td>
 347           <td></td>
 348           <td class="paramtype"><a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;</td>
 349           <td class="paramname"> <em>value</em>, </td>
 350         </tr>
 351         <tr>
 352           <td class="paramkey"></td>
 353           <td></td>
 354           <td class="paramtype">int&nbsp;</td>
 355           <td class="paramname"> <em>length</em>, </td>
 356         </tr>
 357         <tr>
 358           <td class="paramkey"></td>
 359           <td></td>
 360           <td class="paramtype"><a class="el" href="group__styles.html#g3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a>&nbsp;</td>
 361           <td class="paramname"> <em>style</em></td><td>&nbsp;</td>
 362         </tr>
 363         <tr>
 364           <td></td>
 365           <td>)</td>
 366           <td></td><td></td><td width="100%"></td>
 367         </tr>
 368       </table>
 369 </div>
 370 <div class="memdoc">
 371
 372 <p>
 373 Create a SCALAR node and attach it to the document.
 374 <p>
 375 The <em>style</em> argument may be ignored by the emitter.<p>
 376 <dl compact><dt><b>Parameters:</b></dt><dd>
 377   <table border="0" cellspacing="2" cellpadding="0">
 378     <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>A document object. </td></tr>
 379     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>tag</em>&nbsp;</td><td>The scalar tag. </td></tr>
 380     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>value</em>&nbsp;</td><td>The scalar value. </td></tr>
 381     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>length</em>&nbsp;</td><td>The length of the scalar value. </td></tr>
 382     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>style</em>&nbsp;</td><td>The scalar style.</td></tr>
 383   </table>
 384 </dl>
 385 <dl class="return" compact><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl>
 386
 387 </div>
 388 </div><p>
 389 <a class="anchor" name="g83b2f7fdd9a439397a42016bddad7786"></a><!-- doxytag: member="yaml.h::yaml_document_add_sequence" ref="g83b2f7fdd9a439397a42016bddad7786" args="(yaml_document_t *document, yaml_char_t *tag, yaml_sequence_style_t style)" -->
 390 <div class="memitem">
 391 <div class="memproto">
 392       <table class="memname">
 393         <tr>
 394           <td class="memname">int yaml_document_add_sequence           </td>
 395           <td>(</td>
 396           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 397           <td class="paramname"> <em>document</em>, </td>
 398         </tr>
 399         <tr>
 400           <td class="paramkey"></td>
 401           <td></td>
 402           <td class="paramtype"><a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;</td>
 403           <td class="paramname"> <em>tag</em>, </td>
 404         </tr>
 405         <tr>
 406           <td class="paramkey"></td>
 407           <td></td>
 408           <td class="paramtype"><a class="el" href="group__styles.html#g58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a>&nbsp;</td>
 409           <td class="paramname"> <em>style</em></td><td>&nbsp;</td>
 410         </tr>
 411         <tr>
 412           <td></td>
 413           <td>)</td>
 414           <td></td><td></td><td width="100%"></td>
 415         </tr>
 416       </table>
 417 </div>
 418 <div class="memdoc">
 419
 420 <p>
 421 Create a SEQUENCE node and attach it to the document.
 422 <p>
 423 The <em>style</em> argument may be ignored by the emitter.<p>
 424 <dl compact><dt><b>Parameters:</b></dt><dd>
 425   <table border="0" cellspacing="2" cellpadding="0">
 426     <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>A document object. </td></tr>
 427     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>tag</em>&nbsp;</td><td>The sequence tag. </td></tr>
 428     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>style</em>&nbsp;</td><td>The sequence style.</td></tr>
 429   </table>
 430 </dl>
 431 <dl class="return" compact><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl>
 432
 433 </div>
 434 </div><p>
 435 <a class="anchor" name="g45a9f8288704f99cd81dc5cb31329d34"></a><!-- doxytag: member="yaml.h::yaml_document_add_mapping" ref="g45a9f8288704f99cd81dc5cb31329d34" args="(yaml_document_t *document, yaml_char_t *tag, yaml_mapping_style_t style)" -->
 436 <div class="memitem">
 437 <div class="memproto">
 438       <table class="memname">
 439         <tr>
 440           <td class="memname">int yaml_document_add_mapping           </td>
 441           <td>(</td>
 442           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 443           <td class="paramname"> <em>document</em>, </td>
 444         </tr>
 445         <tr>
 446           <td class="paramkey"></td>
 447           <td></td>
 448           <td class="paramtype"><a class="el" href="group__basic.html#gf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&nbsp;</td>
 449           <td class="paramname"> <em>tag</em>, </td>
 450         </tr>
 451         <tr>
 452           <td class="paramkey"></td>
 453           <td></td>
 454           <td class="paramtype"><a class="el" href="group__styles.html#gb47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a>&nbsp;</td>
 455           <td class="paramname"> <em>style</em></td><td>&nbsp;</td>
 456         </tr>
 457         <tr>
 458           <td></td>
 459           <td>)</td>
 460           <td></td><td></td><td width="100%"></td>
 461         </tr>
 462       </table>
 463 </div>
 464 <div class="memdoc">
 465
 466 <p>
 467 Create a MAPPING node and attach it to the document.
 468 <p>
 469 The <em>style</em> argument may be ignored by the emitter.<p>
 470 <dl compact><dt><b>Parameters:</b></dt><dd>
 471   <table border="0" cellspacing="2" cellpadding="0">
 472     <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>A document object. </td></tr>
 473     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>tag</em>&nbsp;</td><td>The sequence tag. </td></tr>
 474     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>style</em>&nbsp;</td><td>The sequence style.</td></tr>
 475   </table>
 476 </dl>
 477 <dl class="return" compact><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl>
 478
 479 </div>
 480 </div><p>
 481 <a class="anchor" name="g16435917cd6c0261cd390fa8cf173b1b"></a><!-- doxytag: member="yaml.h::yaml_document_append_sequence_item" ref="g16435917cd6c0261cd390fa8cf173b1b" args="(yaml_document_t *document, int sequence, int item)" -->
 482 <div class="memitem">
 483 <div class="memproto">
 484       <table class="memname">
 485         <tr>
 486           <td class="memname">int yaml_document_append_sequence_item           </td>
 487           <td>(</td>
 488           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 489           <td class="paramname"> <em>document</em>, </td>
 490         </tr>
 491         <tr>
 492           <td class="paramkey"></td>
 493           <td></td>
 494           <td class="paramtype">int&nbsp;</td>
 495           <td class="paramname"> <em>sequence</em>, </td>
 496         </tr>
 497         <tr>
 498           <td class="paramkey"></td>
 499           <td></td>
 500           <td class="paramtype">int&nbsp;</td>
 501           <td class="paramname"> <em>item</em></td><td>&nbsp;</td>
 502         </tr>
 503         <tr>
 504           <td></td>
 505           <td>)</td>
 506           <td></td><td></td><td width="100%"></td>
 507         </tr>
 508       </table>
 509 </div>
 510 <div class="memdoc">
 511
 512 <p>
 513 Add an item to a SEQUENCE node.
 514 <p>
 515 <dl compact><dt><b>Parameters:</b></dt><dd>
 516   <table border="0" cellspacing="2" cellpadding="0">
 517     <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>A document object. </td></tr>
 518     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>sequence</em>&nbsp;</td><td>The sequence node id. </td></tr>
 519     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>item</em>&nbsp;</td><td>The item node id.</td></tr>
 520   </table>
 521 </dl>
 522 <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 523
 524 </div>
 525 </div><p>
 526 <a class="anchor" name="g2db27002d8a9ae06b1729d0ee06553d2"></a><!-- doxytag: member="yaml.h::yaml_document_append_mapping_pair" ref="g2db27002d8a9ae06b1729d0ee06553d2" args="(yaml_document_t *document, int mapping, int key, int value)" -->
 527 <div class="memitem">
 528 <div class="memproto">
 529       <table class="memname">
 530         <tr>
 531           <td class="memname">int yaml_document_append_mapping_pair           </td>
 532           <td>(</td>
 533           <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> *&nbsp;</td>
 534           <td class="paramname"> <em>document</em>, </td>
 535         </tr>
 536         <tr>
 537           <td class="paramkey"></td>
 538           <td></td>
 539           <td class="paramtype">int&nbsp;</td>
 540           <td class="paramname"> <em>mapping</em>, </td>
 541         </tr>
 542         <tr>
 543           <td class="paramkey"></td>
 544           <td></td>
 545           <td class="paramtype">int&nbsp;</td>
 546           <td class="paramname"> <em>key</em>, </td>
 547         </tr>
 548         <tr>
 549           <td class="paramkey"></td>
 550           <td></td>
 551           <td class="paramtype">int&nbsp;</td>
 552           <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
 553         </tr>
 554         <tr>
 555           <td></td>
 556           <td>)</td>
 557           <td></td><td></td><td width="100%"></td>
 558         </tr>
 559       </table>
 560 </div>
 561 <div class="memdoc">
 562
 563 <p>
 564 Add a pair of a key and a value to a MAPPING node.
 565 <p>
 566 <dl compact><dt><b>Parameters:</b></dt><dd>
 567   <table border="0" cellspacing="2" cellpadding="0">
 568     <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>document</em>&nbsp;</td><td>A document object. </td></tr>
 569     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>mapping</em>&nbsp;</td><td>The mapping node id. </td></tr>
 570     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>key</em>&nbsp;</td><td>The key node id. </td></tr>
 571     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>value</em>&nbsp;</td><td>The value node id.</td></tr>
 572   </table>
 573 </dl>
 574 <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 575
 576 </div>
 577 </div><p>
 578 <hr size="1"><address style="align: right;"><small>Generated on Thu May 31 22:50:59 2007 for yaml by&nbsp;
 579 <a href="http://www.doxygen.org/index.html">
 580 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
 581 </body>
 582 </html>