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.6"/>
   7 <title>yaml: yaml_document_s Struct Reference</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 </head>
  13 <body>
  14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15 <div id="titlearea">
  16 <table cellspacing="0" cellpadding="0">
  17  <tbody>
  18  <tr style="height: 56px;">
  19   <td style="padding-left: 0.5em;">
  20    <div id="projectname">yaml
  21    &#160;<span id="projectnumber">0.1.7</span>
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.6 -->
  30   <div id="navrow1" class="tabs">
  31     <ul class="tablist">
  32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33       <li><a href="modules.html"><span>Modules</span></a></li>
  34       <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  35       <li><a href="files.html"><span>Files</span></a></li>
  36     </ul>
  37   </div>
  38   <div id="navrow2" class="tabs2">
  39     <ul class="tablist">
  40       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  41       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  42     </ul>
  43   </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="summary">
  47 <a href="#pub-attribs">Data Fields</a>  </div>
  48   <div class="headertitle">
  49 <div class="title">yaml_document_s Struct Reference<div class="ingroups"><a class="el" href="group__nodes.html">Nodes</a></div></div>  </div>
  50 </div><!--header-->
  51 <div class="contents">
  52
  53 <p>The document structure.
  54  <a href="structyaml__document__s.html#details">More...</a></p>
  55
  56 <p><code>#include &lt;yaml.h&gt;</code></p>
  57 <table class="memberdecls">
  58 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  59 Data Fields</h2></td></tr>
  60 <tr class="memitem:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="memItemLeft" >struct {</td></tr>
  61 <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>
  62 <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>
  63 <tr class="separator:a47c65aa6e05b1bbdd23ca6bf861057b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 <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>
  65 <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>
  66 <tr class="separator:afbbfd5d4dcbe1f0ce088afa7266518bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <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>
  68 <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>
  69 <tr class="separator:a39d2f17a1edca2641a6b93646e9931b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <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>
  71 <tr class="memdesc:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="mdescLeft">&#160;</td><td class="mdescRight">The document nodes.  <a href="#aa9eeab76b69cc84a6ab1b02c14cfd594">More...</a><br/></td></tr>
  72 <tr class="separator:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 <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>
  74 <tr class="memdesc:a7d36862d070804b8bedb53866487ac6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The version directive.  <a href="#a7d36862d070804b8bedb53866487ac6d">More...</a><br/></td></tr>
  75 <tr class="separator:a7d36862d070804b8bedb53866487ac6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:af1e09d0469fc24106f3790b1e3de09e1"><td class="memItemLeft" >struct {</td></tr>
  77 <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>
  78 <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>
  79 <tr class="separator:a3f9c1d3d7466cc035179e64af2b983d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <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>
  81 <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>
  82 <tr class="separator:aacdf541ee0945d7b3901a71538a7639f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <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>
  84 <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>
  85 <tr class="separator:af1e09d0469fc24106f3790b1e3de09e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65c49e4f61ca5c2f6ecf410e1cc65787"></a>
  87 int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr>
  88 <tr class="memdesc:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the document start indicator implicit? <br/></td></tr>
  89 <tr class="separator:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:a59de90b4078659fd0f49377929afcac1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59de90b4078659fd0f49377929afcac1"></a>
  91 int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr>
  92 <tr class="memdesc:a59de90b4078659fd0f49377929afcac1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the document end indicator implicit? <br/></td></tr>
  93 <tr class="separator:a59de90b4078659fd0f49377929afcac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <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>
  95 <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>
  96 <tr class="separator:a0a37311ebf8f6637e4bc1d280a879997"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 <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>
  98 <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>
  99 <tr class="separator:a9299efdaadf764f4d03641a3ee51e0d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 </table>
 101 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 102 <div class="textblock"><p>The document structure. </p>
 103 </div><h2 class="groupheader">Field Documentation</h2>
 104 <a class="anchor" id="aa3f9a11d8fbe4ac2eada1786176bab89"></a>
 105 <div class="memitem">
 106 <div class="memproto">
 107       <table class="memname">
 108         <tr>
 109           <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_s::start</td>
 110         </tr>
 111       </table>
 112 </div><div class="memdoc">
 113
 114 <p>The beginning of the stack. </p>
 115
 116 </div>
 117 </div>
 118 <a class="anchor" id="adc9ffcca86a2684362428da69ffd3dea"></a>
 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 class="anchor" id="a5ac36f59c4a0f28124c2e1630ca4f227"></a>
 133 <div class="memitem">
 134 <div class="memproto">
 135       <table class="memname">
 136         <tr>
 137           <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_s::top</td>
 138         </tr>
 139       </table>
 140 </div><div class="memdoc">
 141
 142 <p>The top of the stack. </p>
 143
 144 </div>
 145 </div>
 146 <a class="anchor" id="aa9eeab76b69cc84a6ab1b02c14cfd594"></a>
 147 <div class="memitem">
 148 <div class="memproto">
 149       <table class="memname">
 150         <tr>
 151           <td class="memname">struct { ... }   yaml_document_s::nodes</td>
 152         </tr>
 153       </table>
 154 </div><div class="memdoc">
 155
 156 <p>The document nodes. </p>
 157
 158 </div>
 159 </div>
 160 <a class="anchor" id="a7d36862d070804b8bedb53866487ac6d"></a>
 161 <div class="memitem">
 162 <div class="memproto">
 163       <table class="memname">
 164         <tr>
 165           <td class="memname"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a>* yaml_document_s::version_directive</td>
 166         </tr>
 167       </table>
 168 </div><div class="memdoc">
 169
 170 <p>The version directive. </p>
 171
 172 </div>
 173 </div>
 174 <a class="anchor" id="afb9b6cb56a29f880ad6b76c532133c40"></a>
 175 <div class="memitem">
 176 <div class="memproto">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a>* yaml_document_s::start</td>
 180         </tr>
 181       </table>
 182 </div><div class="memdoc">
 183
 184 <p>The beginning of the tag directives list. </p>
 185
 186 </div>
 187 </div>
 188 <a class="anchor" id="af14fd1a6c1fd10088391f07349ba55e8"></a>
 189 <div class="memitem">
 190 <div class="memproto">
 191       <table class="memname">
 192         <tr>
 193           <td class="memname"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a>* yaml_document_s::end</td>
 194         </tr>
 195       </table>
 196 </div><div class="memdoc">
 197
 198 <p>The end of the tag directives list. </p>
 199
 200 </div>
 201 </div>
 202 <a class="anchor" id="af1e09d0469fc24106f3790b1e3de09e1"></a>
 203 <div class="memitem">
 204 <div class="memproto">
 205       <table class="memname">
 206         <tr>
 207           <td class="memname">struct { ... }   yaml_document_s::tag_directives</td>
 208         </tr>
 209       </table>
 210 </div><div class="memdoc">
 211
 212 <p>The list of tag directives. </p>
 213
 214 </div>
 215 </div>
 216 <a class="anchor" id="a0a37311ebf8f6637e4bc1d280a879997"></a>
 217 <div class="memitem">
 218 <div class="memproto">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a> yaml_document_s::start_mark</td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225
 226 <p>The beginning of the document. </p>
 227
 228 </div>
 229 </div>
 230 <a class="anchor" id="a9299efdaadf764f4d03641a3ee51e0d0"></a>
 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::end_mark</td>
 236         </tr>
 237       </table>
 238 </div><div class="memdoc">
 239
 240 <p>The end of the document. </p>
 241
 242 </div>
 243 </div>
 244 <hr/>The documentation for this struct was generated from the following file:<ul>
 245 <li><a class="el" href="yaml_8h.html">yaml.h</a></li>
 246 </ul>
 247 </div><!-- contents -->
 248 <!-- start footer part -->
 249 <hr class="footer"/><address class="footer"><small>
 250 Generated on Sun Aug 28 2016 23:56:54 for yaml by &#160;<a href="http://www.doxygen.org/index.html">
 251 <img class="footer" src="doxygen.png" alt="doxygen"/>
 252 </a> 1.8.6
 253 </small></address>
 254 </body>
 255 </html>