publics
/
yaml.v2


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
							<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>yaml: yaml_document_s Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>yaml_document_s Struct Reference<br>
<small>
[<a class="el" href="group__nodes.html">Nodes</a>]</small>
</h1><!-- doxytag: class="yaml_document_s" -->The document structure.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;yaml.h&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap>struct {</td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#a3f9a11d8fbe4ac2eada1786176bab89">start</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the stack.  <a href="#5afb9c4ff4dfa2564d94f10b9b3a5cff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#dc9ffcca86a2684362428da69ffd3dea">end</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the stack.  <a href="#95e8c8484a1d072cd12fe8e9bbfc5637"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#5ac36f59c4a0f28124c2e1630ca4f227">top</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The top of the stack.  <a href="#fdfa6febcc566fd5eab4af30f2d2b535"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a9eeab76b69cc84a6ab1b02c14cfd594">nodes</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The document nodes.  <a href="#a9eeab76b69cc84a6ab1b02c14cfd594"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#7d36862d070804b8bedb53866487ac6d">version_directive</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The version directive.  <a href="#7d36862d070804b8bedb53866487ac6d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>struct {</td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#fb9b6cb56a29f880ad6b76c532133c40">start</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the tag directives list.  <a href="#fbbf86f866b471bc8bdd14cf93b41f31"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#f14fd1a6c1fd10088391f07349ba55e8">end</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the tag directives list.  <a href="#5557c8dc0a0c72a979c33dfdc948fffb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#f1e09d0469fc24106f3790b1e3de09e1">tag_directives</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list of tag directives.  <a href="#f1e09d0469fc24106f3790b1e3de09e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65c49e4f61ca5c2f6ecf410e1cc65787"></a><!-- doxytag: member="yaml_document_s::start_implicit" ref="65c49e4f61ca5c2f6ecf410e1cc65787" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the document start indicator implicit? <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59de90b4078659fd0f49377929afcac1"></a><!-- doxytag: member="yaml_document_s::end_implicit" ref="59de90b4078659fd0f49377929afcac1" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the document end indicator implicit? <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#0a37311ebf8f6637e4bc1d280a879997">start_mark</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the document.  <a href="#0a37311ebf8f6637e4bc1d280a879997"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#9299efdaadf764f4d03641a3ee51e0d0">end_mark</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the document.  <a href="#9299efdaadf764f4d03641a3ee51e0d0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The document structure. 
<p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="a3f9a11d8fbe4ac2eada1786176bab89"></a><!-- doxytag: member="yaml_document_s::start" ref="a3f9a11d8fbe4ac2eada1786176bab89" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#a3f9a11d8fbe4ac2eada1786176bab89">yaml_document_s::start</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The beginning of the stack. 
<p>

</div>
</div><p>
<a class="anchor" name="dc9ffcca86a2684362428da69ffd3dea"></a><!-- doxytag: member="yaml_document_s::end" ref="dc9ffcca86a2684362428da69ffd3dea" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#dc9ffcca86a2684362428da69ffd3dea">yaml_document_s::end</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The end of the stack. 
<p>

</div>
</div><p>
<a class="anchor" name="5ac36f59c4a0f28124c2e1630ca4f227"></a><!-- doxytag: member="yaml_document_s::top" ref="5ac36f59c4a0f28124c2e1630ca4f227" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#5ac36f59c4a0f28124c2e1630ca4f227">yaml_document_s::top</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The top of the stack. 
<p>

</div>
</div><p>
<a class="anchor" name="a9eeab76b69cc84a6ab1b02c14cfd594"></a><!-- doxytag: member="yaml_document_s::nodes" ref="a9eeab76b69cc84a6ab1b02c14cfd594" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   <a class="el" href="structyaml__document__s.html#a9eeab76b69cc84a6ab1b02c14cfd594">yaml_document_s::nodes</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The document nodes. 
<p>

</div>
</div><p>
<a class="anchor" name="7d36862d070804b8bedb53866487ac6d"></a><!-- doxytag: member="yaml_document_s::version_directive" ref="7d36862d070804b8bedb53866487ac6d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a>* <a class="el" href="structyaml__document__s.html#7d36862d070804b8bedb53866487ac6d">yaml_document_s::version_directive</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The version directive. 
<p>

</div>
</div><p>
<a class="anchor" name="fb9b6cb56a29f880ad6b76c532133c40"></a><!-- doxytag: member="yaml_document_s::start" ref="fb9b6cb56a29f880ad6b76c532133c40" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a>* <a class="el" href="structyaml__document__s.html#a3f9a11d8fbe4ac2eada1786176bab89">yaml_document_s::start</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The beginning of the tag directives list. 
<p>

</div>
</div><p>
<a class="anchor" name="f14fd1a6c1fd10088391f07349ba55e8"></a><!-- doxytag: member="yaml_document_s::end" ref="f14fd1a6c1fd10088391f07349ba55e8" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a>* <a class="el" href="structyaml__document__s.html#dc9ffcca86a2684362428da69ffd3dea">yaml_document_s::end</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The end of the tag directives list. 
<p>

</div>
</div><p>
<a class="anchor" name="f1e09d0469fc24106f3790b1e3de09e1"></a><!-- doxytag: member="yaml_document_s::tag_directives" ref="f1e09d0469fc24106f3790b1e3de09e1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   <a class="el" href="structyaml__document__s.html#f1e09d0469fc24106f3790b1e3de09e1">yaml_document_s::tag_directives</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The list of tag directives. 
<p>

</div>
</div><p>
<a class="anchor" name="0a37311ebf8f6637e4bc1d280a879997"></a><!-- doxytag: member="yaml_document_s::start_mark" ref="0a37311ebf8f6637e4bc1d280a879997" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> <a class="el" href="structyaml__document__s.html#0a37311ebf8f6637e4bc1d280a879997">yaml_document_s::start_mark</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The beginning of the document. 
<p>

</div>
</div><p>
<a class="anchor" name="9299efdaadf764f4d03641a3ee51e0d0"></a><!-- doxytag: member="yaml_document_s::end_mark" ref="9299efdaadf764f4d03641a3ee51e0d0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> <a class="el" href="structyaml__document__s.html#9299efdaadf764f4d03641a3ee51e0d0">yaml_document_s::end_mark</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The end of the document. 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="yaml_8h.html">yaml.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 30 22:52:14 2009 for yaml by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>