doc/html/structyaml__document__s.html

   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"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.14"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>yaml: yaml_document_s Struct Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">yaml
  22    &#160;<span id="projectnumber">0.2.2</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.14 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#pub-attribs">Data Fields</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">yaml_document_s Struct Reference<div class="ingroups"><a class="el" href="group__nodes.html">Nodes</a></div></div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48
  49 <p>The document structure.
  50  <a href="structyaml__document__s.html#details">More...</a></p>
  51
  52 <p><code>#include &lt;yaml.h&gt;</code></p>
  53 <table class="memberdecls">
  54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  55 Data Fields</h2></td></tr>
  56 <tr class="memitem:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="memItemLeft" >struct {</td></tr>
  57 <tr class="memitem:a47c65aa6e05b1bbdd23ca6bf861057b7"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#aa3f9a11d8fbe4ac2eada1786176bab89">start</a></td></tr>
  58 <tr class="memdesc:a47c65aa6e05b1bbdd23ca6bf861057b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The beginning of the stack.  <a href="#a47c65aa6e05b1bbdd23ca6bf861057b7">More...</a><br /></td></tr>
  59 <tr class="separator:a47c65aa6e05b1bbdd23ca6bf861057b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60 <tr class="memitem:afbbfd5d4dcbe1f0ce088afa7266518bf"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#adc9ffcca86a2684362428da69ffd3dea">end</a></td></tr>
  61 <tr class="memdesc:afbbfd5d4dcbe1f0ce088afa7266518bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The end of the stack.  <a href="#afbbfd5d4dcbe1f0ce088afa7266518bf">More...</a><br /></td></tr>
  62 <tr class="separator:afbbfd5d4dcbe1f0ce088afa7266518bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 <tr class="memitem:a39d2f17a1edca2641a6b93646e9931b6"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#a5ac36f59c4a0f28124c2e1630ca4f227">top</a></td></tr>
  64 <tr class="memdesc:a39d2f17a1edca2641a6b93646e9931b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The top of the stack.  <a href="#a39d2f17a1edca2641a6b93646e9931b6">More...</a><br /></td></tr>
  65 <tr class="separator:a39d2f17a1edca2641a6b93646e9931b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#aa9eeab76b69cc84a6ab1b02c14cfd594">nodes</a></td></tr>
  67 <tr class="memdesc:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="mdescLeft">&#160;</td><td class="mdescRight">The document nodes.  <a href="#aa9eeab76b69cc84a6ab1b02c14cfd594">More...</a><br /></td></tr>
  68 <tr class="separator:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:a7d36862d070804b8bedb53866487ac6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a7d36862d070804b8bedb53866487ac6d">version_directive</a></td></tr>
  70 <tr class="memdesc:a7d36862d070804b8bedb53866487ac6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The version directive.  <a href="#a7d36862d070804b8bedb53866487ac6d">More...</a><br /></td></tr>
  71 <tr class="separator:a7d36862d070804b8bedb53866487ac6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:af1e09d0469fc24106f3790b1e3de09e1"><td class="memItemLeft" >struct {</td></tr>
  73 <tr class="memitem:a3f9c1d3d7466cc035179e64af2b983d5"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#afb9b6cb56a29f880ad6b76c532133c40">start</a></td></tr>
  74 <tr class="memdesc:a3f9c1d3d7466cc035179e64af2b983d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The beginning of the tag directives list.  <a href="#a3f9c1d3d7466cc035179e64af2b983d5">More...</a><br /></td></tr>
  75 <tr class="separator:a3f9c1d3d7466cc035179e64af2b983d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:aacdf541ee0945d7b3901a71538a7639f"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#af14fd1a6c1fd10088391f07349ba55e8">end</a></td></tr>
  77 <tr class="memdesc:aacdf541ee0945d7b3901a71538a7639f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The end of the tag directives list.  <a href="#aacdf541ee0945d7b3901a71538a7639f">More...</a><br /></td></tr>
  78 <tr class="separator:aacdf541ee0945d7b3901a71538a7639f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:af1e09d0469fc24106f3790b1e3de09e1"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#af1e09d0469fc24106f3790b1e3de09e1">tag_directives</a></td></tr>
  80 <tr class="memdesc:af1e09d0469fc24106f3790b1e3de09e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of tag directives.  <a href="#af1e09d0469fc24106f3790b1e3de09e1">More...</a><br /></td></tr>
  81 <tr class="separator:af1e09d0469fc24106f3790b1e3de09e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="memItemLeft" align="right" valign="top"><a id="a65c49e4f61ca5c2f6ecf410e1cc65787"></a>
  83 int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr>
  84 <tr class="memdesc:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the document start indicator implicit? <br /></td></tr>
  85 <tr class="separator:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a59de90b4078659fd0f49377929afcac1"><td class="memItemLeft" align="right" valign="top"><a id="a59de90b4078659fd0f49377929afcac1"></a>
  87 int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr>
  88 <tr class="memdesc:a59de90b4078659fd0f49377929afcac1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the document end indicator implicit? <br /></td></tr>
  89 <tr class="separator:a59de90b4078659fd0f49377929afcac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:a0a37311ebf8f6637e4bc1d280a879997"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a0a37311ebf8f6637e4bc1d280a879997">start_mark</a></td></tr>
  91 <tr class="memdesc:a0a37311ebf8f6637e4bc1d280a879997"><td class="mdescLeft">&#160;</td><td class="mdescRight">The beginning of the document.  <a href="#a0a37311ebf8f6637e4bc1d280a879997">More...</a><br /></td></tr>
  92 <tr class="separator:a0a37311ebf8f6637e4bc1d280a879997"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 <tr class="memitem:a9299efdaadf764f4d03641a3ee51e0d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a9299efdaadf764f4d03641a3ee51e0d0">end_mark</a></td></tr>
  94 <tr class="memdesc:a9299efdaadf764f4d03641a3ee51e0d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The end of the document.  <a href="#a9299efdaadf764f4d03641a3ee51e0d0">More...</a><br /></td></tr>
  95 <tr class="separator:a9299efdaadf764f4d03641a3ee51e0d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 </table>
  97 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  98 <div class="textblock"><p>The document structure. </p>
  99 </div><h2 class="groupheader">Field Documentation</h2>
 100 <a id="aa3f9a11d8fbe4ac2eada1786176bab89"></a>
 101 <h2 class="memtitle"><span class="permalink"><a href="#aa3f9a11d8fbe4ac2eada1786176bab89">&#9670;&nbsp;</a></span>start <span class="overload">[1/2]</span></h2>
 102
 103 <div class="memitem">
 104 <div class="memproto">
 105       <table class="memname">
 106         <tr>
 107           <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_s::start</td>
 108         </tr>
 109       </table>
 110 </div><div class="memdoc">
 111
 112 <p>The beginning of the stack. </p>
 113
 114 </div>
 115 </div>
 116 <a id="adc9ffcca86a2684362428da69ffd3dea"></a>
 117 <h2 class="memtitle"><span class="permalink"><a href="#adc9ffcca86a2684362428da69ffd3dea">&#9670;&nbsp;</a></span>end <span class="overload">[1/2]</span></h2>
 118
 119 <div class="memitem">
 120 <div class="memproto">
 121       <table class="memname">
 122         <tr>
 123           <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_s::end</td>
 124         </tr>
 125       </table>
 126 </div><div class="memdoc">
 127
 128 <p>The end of the stack. </p>
 129
 130 </div>
 131 </div>
 132 <a id="a5ac36f59c4a0f28124c2e1630ca4f227"></a>
 133 <h2 class="memtitle"><span class="permalink"><a href="#a5ac36f59c4a0f28124c2e1630ca4f227">&#9670;&nbsp;</a></span>top</h2>
 134
 135 <div class="memitem">
 136 <div class="memproto">
 137       <table class="memname">
 138         <tr>
 139           <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_s::top</td>
 140         </tr>
 141       </table>
 142 </div><div class="memdoc">
 143
 144 <p>The top of the stack. </p>
 145
 146 </div>
 147 </div>
 148 <a id="aa9eeab76b69cc84a6ab1b02c14cfd594"></a>
 149 <h2 class="memtitle"><span class="permalink"><a href="#aa9eeab76b69cc84a6ab1b02c14cfd594">&#9670;&nbsp;</a></span>nodes</h2>
 150
 151 <div class="memitem">
 152 <div class="memproto">
 153       <table class="memname">
 154         <tr>
 155           <td class="memname">struct { ... }   yaml_document_s::nodes</td>
 156         </tr>
 157       </table>
 158 </div><div class="memdoc">
 159
 160 <p>The document nodes. </p>
 161
 162 </div>
 163 </div>
 164 <a id="a7d36862d070804b8bedb53866487ac6d"></a>
 165 <h2 class="memtitle"><span class="permalink"><a href="#a7d36862d070804b8bedb53866487ac6d">&#9670;&nbsp;</a></span>version_directive</h2>
 166
 167 <div class="memitem">
 168 <div class="memproto">
 169       <table class="memname">
 170         <tr>
 171           <td class="memname"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a>* yaml_document_s::version_directive</td>
 172         </tr>
 173       </table>
 174 </div><div class="memdoc">
 175
 176 <p>The version directive. </p>
 177
 178 </div>
 179 </div>
 180 <a id="afb9b6cb56a29f880ad6b76c532133c40"></a>
 181 <h2 class="memtitle"><span class="permalink"><a href="#afb9b6cb56a29f880ad6b76c532133c40">&#9670;&nbsp;</a></span>start <span class="overload">[2/2]</span></h2>
 182
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a>* yaml_document_s::start</td>
 188         </tr>
 189       </table>
 190 </div><div class="memdoc">
 191
 192 <p>The beginning of the tag directives list. </p>
 193
 194 </div>
 195 </div>
 196 <a id="af14fd1a6c1fd10088391f07349ba55e8"></a>
 197 <h2 class="memtitle"><span class="permalink"><a href="#af14fd1a6c1fd10088391f07349ba55e8">&#9670;&nbsp;</a></span>end <span class="overload">[2/2]</span></h2>
 198
 199 <div class="memitem">
 200 <div class="memproto">
 201       <table class="memname">
 202         <tr>
 203           <td class="memname"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a>* yaml_document_s::end</td>
 204         </tr>
 205       </table>
 206 </div><div class="memdoc">
 207
 208 <p>The end of the tag directives list. </p>
 209
 210 </div>
 211 </div>
 212 <a id="af1e09d0469fc24106f3790b1e3de09e1"></a>
 213 <h2 class="memtitle"><span class="permalink"><a href="#af1e09d0469fc24106f3790b1e3de09e1">&#9670;&nbsp;</a></span>tag_directives</h2>
 214
 215 <div class="memitem">
 216 <div class="memproto">
 217       <table class="memname">
 218         <tr>
 219           <td class="memname">struct { ... }   yaml_document_s::tag_directives</td>
 220         </tr>
 221       </table>
 222 </div><div class="memdoc">
 223
 224 <p>The list of tag directives. </p>
 225
 226 </div>
 227 </div>
 228 <a id="a0a37311ebf8f6637e4bc1d280a879997"></a>
 229 <h2 class="memtitle"><span class="permalink"><a href="#a0a37311ebf8f6637e4bc1d280a879997">&#9670;&nbsp;</a></span>start_mark</h2>
 230
 231 <div class="memitem">
 232 <div class="memproto">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a> yaml_document_s::start_mark</td>
 236         </tr>
 237       </table>
 238 </div><div class="memdoc">
 239
 240 <p>The beginning of the document. </p>
 241
 242 </div>
 243 </div>
 244 <a id="a9299efdaadf764f4d03641a3ee51e0d0"></a>
 245 <h2 class="memtitle"><span class="permalink"><a href="#a9299efdaadf764f4d03641a3ee51e0d0">&#9670;&nbsp;</a></span>end_mark</h2>
 246
 247 <div class="memitem">
 248 <div class="memproto">
 249       <table class="memname">
 250         <tr>
 251           <td class="memname"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a> yaml_document_s::end_mark</td>
 252         </tr>
 253       </table>
 254 </div><div class="memdoc">
 255
 256 <p>The end of the document. </p>
 257
 258 </div>
 259 </div>
 260 <hr/>The documentation for this struct was generated from the following file:<ul>
 261 <li><a class="el" href="yaml_8h.html">yaml.h</a></li>
 262 </ul>
 263 </div><!-- contents -->
 264 <!-- start footer part -->
 265 <hr class="footer"/><address class="footer"><small>
 266 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 267 <img class="footer" src="doxygen.png" alt="doxygen"/>
 268 </a> 1.8.14
 269 </small></address>
 270 </body>
 271 </html>