source: trunk/packages/libyaml/doc/html/group__tokens.html @ 898

Last change on this file since 898 was 898, checked in by hartmans, 17 years ago

Add pyyaml and libyaml packages
backported from lenny.
There is discussion about how these should go in the repository; these are added in this form
in order to make forward progress.

File size: 15.4 KB
RevLine 
[898]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: Tokens</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>Tokens</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__token__s.html">yaml_token_s</a></td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The token structure.  <a href="structyaml__token__s.html#_details">More...</a><br></td></tr>
21<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
22<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gba51dda022dced02f8df2224ab7993f7"></a><!-- doxytag: member="tokens::yaml_token_type_t" ref="gba51dda022dced02f8df2224ab7993f7" args="" -->
23typedef enum <a class="el" href="group__tokens.html#gae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#gba51dda022dced02f8df2224ab7993f7">yaml_token_type_t</a></td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Token types. <br></td></tr>
26<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1ed3dc460e62aee8270c5d63d5734bbb"></a><!-- doxytag: member="tokens::yaml_token_t" ref="g1ed3dc460e62aee8270c5d63d5734bbb" args="" -->
27typedef <a class="el" href="structyaml__token__s.html">yaml_token_s</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#g1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a></td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The token structure. <br></td></tr>
30<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
31<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#gae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a> { <br>
32&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd66c1b8eec0cc6402c0fb4b2d1b017f92">YAML_NO_TOKEN</a>,
33<br>
34&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdf5f42f2d5025e5629034848d2e1db6c9">YAML_STREAM_START_TOKEN</a>,
35<br>
36&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd020a0a266ed7fc4902dd02750512dc19">YAML_STREAM_END_TOKEN</a>,
37<br>
38&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbda15a96ec81c00c7db8f83628a89542e4">YAML_VERSION_DIRECTIVE_TOKEN</a>,
39<br>
40&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbded517a61b868769e2bfced40678be414">YAML_TAG_DIRECTIVE_TOKEN</a>,
41<br>
42&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdbcafcdb506886387f93cca734ddfd670">YAML_DOCUMENT_START_TOKEN</a>,
43<br>
44&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd8d0908a82229f44d5ea92a2c380f4579">YAML_DOCUMENT_END_TOKEN</a>,
45<br>
46&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd4bfddc427da159168ee47267cbeea94f">YAML_BLOCK_SEQUENCE_START_TOKEN</a>,
47<br>
48&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd9a95db99bd99f7f9b4e1e879106297dc">YAML_BLOCK_MAPPING_START_TOKEN</a>,
49<br>
50&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd439948425097b4fc853f39f0de14a5ff">YAML_BLOCK_END_TOKEN</a>,
51<br>
52&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd862a2390be4abd59bb7bf55b18d9260c">YAML_FLOW_SEQUENCE_START_TOKEN</a>,
53<br>
54&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdb3496580bee30936f756e0102e98f331">YAML_FLOW_SEQUENCE_END_TOKEN</a>,
55<br>
56&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdff68a3f7c000c5294211eef8f4156100">YAML_FLOW_MAPPING_START_TOKEN</a>,
57<br>
58&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdad99bf47234572d9d0eeea7669d1e769">YAML_FLOW_MAPPING_END_TOKEN</a>,
59<br>
60&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbda9bdf1d6da41fcd4d356c7bcfa0227b4">YAML_BLOCK_ENTRY_TOKEN</a>,
61<br>
62&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdf11ab5655350e4cf0559f78382daa93f">YAML_FLOW_ENTRY_TOKEN</a>,
63<br>
64&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd94d701c1f5bb8a392bb45b7cbf4bc2a5">YAML_KEY_TOKEN</a>,
65<br>
66&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdac46e8a6a6e0614de322c7b53d785b4e">YAML_VALUE_TOKEN</a>,
67<br>
68&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd080c398f6fc31f9ab35c7cf94cf948c2">YAML_ALIAS_TOKEN</a>,
69<br>
70&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd7f0855938c5ccc4820b68ddd7985a5d0">YAML_ANCHOR_TOKEN</a>,
71<br>
72&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd8f02c514b72f29bd3c26b7c832d8152d">YAML_TAG_TOKEN</a>,
73<br>
74&nbsp;&nbsp;<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd107a78f31dd9857d06e9ead7936ea51e">YAML_SCALAR_TOKEN</a>
75<br>
76 }</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Token types.  <a href="group__tokens.html#gae955b10aa6b5f922de64873bf4ccdbd">More...</a><br></td></tr>
79<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#g3140131870e38e27f92a8fd286e5c004">yaml_token_delete</a> (<a class="el" href="structyaml__token__s.html">yaml_token_t</a> *token)</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Free any memory allocated for a token object.  <a href="#g3140131870e38e27f92a8fd286e5c004"></a><br></td></tr>
83</table>
84<hr><h2>Enumeration Type Documentation</h2>
85<a class="anchor" name="gae955b10aa6b5f922de64873bf4ccdbd"></a><!-- doxytag: member="yaml.h::yaml_token_type_e" ref="gae955b10aa6b5f922de64873bf4ccdbd" args="" -->
86<div class="memitem">
87<div class="memproto">
88      <table class="memname">
89        <tr>
90          <td class="memname">enum <a class="el" href="group__tokens.html#gae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a>          </td>
91        </tr>
92      </table>
93</div>
94<div class="memdoc">
95
96<p>
97Token types.
98<p>
99<dl compact><dt><b>Enumerator: </b></dt><dd>
100<table border="0" cellspacing="2" cellpadding="0">
101<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd66c1b8eec0cc6402c0fb4b2d1b017f92"></a><!-- doxytag: member="YAML_NO_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd66c1b8eec0cc6402c0fb4b2d1b017f92" args="" -->YAML_NO_TOKEN</em>&nbsp;</td><td>
102An empty token. </td></tr>
103<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbdf5f42f2d5025e5629034848d2e1db6c9"></a><!-- doxytag: member="YAML_STREAM_START_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbdf5f42f2d5025e5629034848d2e1db6c9" args="" -->YAML_STREAM_START_TOKEN</em>&nbsp;</td><td>
104A STREAM-START token. </td></tr>
105<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd020a0a266ed7fc4902dd02750512dc19"></a><!-- doxytag: member="YAML_STREAM_END_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd020a0a266ed7fc4902dd02750512dc19" args="" -->YAML_STREAM_END_TOKEN</em>&nbsp;</td><td>
106A STREAM-END token. </td></tr>
107<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbda15a96ec81c00c7db8f83628a89542e4"></a><!-- doxytag: member="YAML_VERSION_DIRECTIVE_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbda15a96ec81c00c7db8f83628a89542e4" args="" -->YAML_VERSION_DIRECTIVE_TOKEN</em>&nbsp;</td><td>
108A VERSION-DIRECTIVE token. </td></tr>
109<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbded517a61b868769e2bfced40678be414"></a><!-- doxytag: member="YAML_TAG_DIRECTIVE_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbded517a61b868769e2bfced40678be414" args="" -->YAML_TAG_DIRECTIVE_TOKEN</em>&nbsp;</td><td>
110A TAG-DIRECTIVE token. </td></tr>
111<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbdbcafcdb506886387f93cca734ddfd670"></a><!-- doxytag: member="YAML_DOCUMENT_START_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbdbcafcdb506886387f93cca734ddfd670" args="" -->YAML_DOCUMENT_START_TOKEN</em>&nbsp;</td><td>
112A DOCUMENT-START token. </td></tr>
113<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd8d0908a82229f44d5ea92a2c380f4579"></a><!-- doxytag: member="YAML_DOCUMENT_END_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd8d0908a82229f44d5ea92a2c380f4579" args="" -->YAML_DOCUMENT_END_TOKEN</em>&nbsp;</td><td>
114A DOCUMENT-END token. </td></tr>
115<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd4bfddc427da159168ee47267cbeea94f"></a><!-- doxytag: member="YAML_BLOCK_SEQUENCE_START_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd4bfddc427da159168ee47267cbeea94f" args="" -->YAML_BLOCK_SEQUENCE_START_TOKEN</em>&nbsp;</td><td>
116A BLOCK-SEQUENCE-START token. </td></tr>
117<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd9a95db99bd99f7f9b4e1e879106297dc"></a><!-- doxytag: member="YAML_BLOCK_MAPPING_START_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd9a95db99bd99f7f9b4e1e879106297dc" args="" -->YAML_BLOCK_MAPPING_START_TOKEN</em>&nbsp;</td><td>
118A BLOCK-SEQUENCE-END token. </td></tr>
119<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd439948425097b4fc853f39f0de14a5ff"></a><!-- doxytag: member="YAML_BLOCK_END_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd439948425097b4fc853f39f0de14a5ff" args="" -->YAML_BLOCK_END_TOKEN</em>&nbsp;</td><td>
120A BLOCK-END token. </td></tr>
121<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd862a2390be4abd59bb7bf55b18d9260c"></a><!-- doxytag: member="YAML_FLOW_SEQUENCE_START_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd862a2390be4abd59bb7bf55b18d9260c" args="" -->YAML_FLOW_SEQUENCE_START_TOKEN</em>&nbsp;</td><td>
122A FLOW-SEQUENCE-START token. </td></tr>
123<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbdb3496580bee30936f756e0102e98f331"></a><!-- doxytag: member="YAML_FLOW_SEQUENCE_END_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbdb3496580bee30936f756e0102e98f331" args="" -->YAML_FLOW_SEQUENCE_END_TOKEN</em>&nbsp;</td><td>
124A FLOW-SEQUENCE-END token. </td></tr>
125<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbdff68a3f7c000c5294211eef8f4156100"></a><!-- doxytag: member="YAML_FLOW_MAPPING_START_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbdff68a3f7c000c5294211eef8f4156100" args="" -->YAML_FLOW_MAPPING_START_TOKEN</em>&nbsp;</td><td>
126A FLOW-MAPPING-START token. </td></tr>
127<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbdad99bf47234572d9d0eeea7669d1e769"></a><!-- doxytag: member="YAML_FLOW_MAPPING_END_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbdad99bf47234572d9d0eeea7669d1e769" args="" -->YAML_FLOW_MAPPING_END_TOKEN</em>&nbsp;</td><td>
128A FLOW-MAPPING-END token. </td></tr>
129<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbda9bdf1d6da41fcd4d356c7bcfa0227b4"></a><!-- doxytag: member="YAML_BLOCK_ENTRY_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbda9bdf1d6da41fcd4d356c7bcfa0227b4" args="" -->YAML_BLOCK_ENTRY_TOKEN</em>&nbsp;</td><td>
130A BLOCK-ENTRY token. </td></tr>
131<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbdf11ab5655350e4cf0559f78382daa93f"></a><!-- doxytag: member="YAML_FLOW_ENTRY_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbdf11ab5655350e4cf0559f78382daa93f" args="" -->YAML_FLOW_ENTRY_TOKEN</em>&nbsp;</td><td>
132A FLOW-ENTRY token. </td></tr>
133<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd94d701c1f5bb8a392bb45b7cbf4bc2a5"></a><!-- doxytag: member="YAML_KEY_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd94d701c1f5bb8a392bb45b7cbf4bc2a5" args="" -->YAML_KEY_TOKEN</em>&nbsp;</td><td>
134A KEY token. </td></tr>
135<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbdac46e8a6a6e0614de322c7b53d785b4e"></a><!-- doxytag: member="YAML_VALUE_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbdac46e8a6a6e0614de322c7b53d785b4e" args="" -->YAML_VALUE_TOKEN</em>&nbsp;</td><td>
136A VALUE token. </td></tr>
137<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd080c398f6fc31f9ab35c7cf94cf948c2"></a><!-- doxytag: member="YAML_ALIAS_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd080c398f6fc31f9ab35c7cf94cf948c2" args="" -->YAML_ALIAS_TOKEN</em>&nbsp;</td><td>
138An ALIAS token. </td></tr>
139<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd7f0855938c5ccc4820b68ddd7985a5d0"></a><!-- doxytag: member="YAML_ANCHOR_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd7f0855938c5ccc4820b68ddd7985a5d0" args="" -->YAML_ANCHOR_TOKEN</em>&nbsp;</td><td>
140An ANCHOR token. </td></tr>
141<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd8f02c514b72f29bd3c26b7c832d8152d"></a><!-- doxytag: member="YAML_TAG_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd8f02c514b72f29bd3c26b7c832d8152d" args="" -->YAML_TAG_TOKEN</em>&nbsp;</td><td>
142A TAG token. </td></tr>
143<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd107a78f31dd9857d06e9ead7936ea51e"></a><!-- doxytag: member="YAML_SCALAR_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd107a78f31dd9857d06e9ead7936ea51e" args="" -->YAML_SCALAR_TOKEN</em>&nbsp;</td><td>
144A SCALAR token. </td></tr>
145</table>
146</dl>
147
148</div>
149</div><p>
150<hr><h2>Function Documentation</h2>
151<a class="anchor" name="g3140131870e38e27f92a8fd286e5c004"></a><!-- doxytag: member="yaml.h::yaml_token_delete" ref="g3140131870e38e27f92a8fd286e5c004" args="(yaml_token_t *token)" -->
152<div class="memitem">
153<div class="memproto">
154      <table class="memname">
155        <tr>
156          <td class="memname">void yaml_token_delete           </td>
157          <td>(</td>
158          <td class="paramtype"><a class="el" href="structyaml__token__s.html">yaml_token_t</a> *&nbsp;</td>
159          <td class="paramname"> <em>token</em>          </td>
160          <td>&nbsp;)&nbsp;</td>
161          <td width="100%"></td>
162        </tr>
163      </table>
164</div>
165<div class="memdoc">
166
167<p>
168Free any memory allocated for a token object.
169<p>
170<dl compact><dt><b>Parameters:</b></dt><dd>
171  <table border="0" cellspacing="2" cellpadding="0">
172    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>token</em>&nbsp;</td><td>A token object. </td></tr>
173  </table>
174</dl>
175
176</div>
177</div><p>
178<hr size="1"><address style="align: right;"><small>Generated on Thu May 31 22:50:59 2007 for yaml by&nbsp;
179<a href="http://www.doxygen.org/index.html">
180<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
181</body>
182</html>
Note: See TracBrowser for help on using the repository browser.