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<title>yaml: Tokens</title> 6<link href="tabs.css" rel="stylesheet" type="text/css"/> 7<link href="doxygen.css" rel="stylesheet" type="text/css"/> 8</head> 9<body> 10<!-- Generated by Doxygen 1.7.1 --> 11<div class="navigation" id="top"> 12 <div class="tabs"> 13 <ul class="tablist"> 14 <li><a href="index.html"><span>Main Page</span></a></li> 15 <li><a href="modules.html"><span>Modules</span></a></li> 16 <li><a href="annotated.html"><span>Data Structures</span></a></li> 17 <li><a href="files.html"><span>Files</span></a></li> 18 </ul> 19 </div> 20</div> 21<div class="header"> 22 <div class="summary"> 23<a href="#nested-classes">Data Structures</a> | 24<a href="#typedef-members">Typedefs</a> | 25<a href="#enum-members">Enumerations</a> | 26<a href="#func-members">Functions</a> </div> 27 <div class="headertitle"> 28<h1>Tokens</h1> </div> 29</div> 30<div class="contents"> 31<table class="memberdecls"> 32<tr><td colspan="2"><h2><a name="nested-classes"></a> 33Data Structures</h2></td></tr> 34<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__token__s.html">yaml_token_s</a></td></tr> 35<tr><td class="mdescLeft"> </td><td class="mdescRight">The token structure. <a href="structyaml__token__s.html#_details">More...</a><br/></td></tr> 36<tr><td colspan="2"><h2><a name="typedef-members"></a> 37Typedefs</h2></td></tr> 38<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#gaba51dda022dced02f8df2224ab7993f7">yaml_token_type_t</a></td></tr> 39<tr><td class="mdescLeft"> </td><td class="mdescRight">Token types. <a href="#gaba51dda022dced02f8df2224ab7993f7"></a><br/></td></tr> 40<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__token__s.html">yaml_token_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a></td></tr> 41<tr><td class="mdescLeft"> </td><td class="mdescRight">The token structure. <a href="#ga1ed3dc460e62aee8270c5d63d5734bbb"></a><br/></td></tr> 42<tr><td colspan="2"><h2><a name="enum-members"></a> 43Enumerations</h2></td></tr> 44<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a> { <br/> 45 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda66c1b8eec0cc6402c0fb4b2d1b017f92">YAML_NO_TOKEN</a>, 46<br/> 47 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaf5f42f2d5025e5629034848d2e1db6c9">YAML_STREAM_START_TOKEN</a>, 48<br/> 49 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda020a0a266ed7fc4902dd02750512dc19">YAML_STREAM_END_TOKEN</a>, 50<br/> 51 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaa15a96ec81c00c7db8f83628a89542e4">YAML_VERSION_DIRECTIVE_TOKEN</a>, 52<br/> 53 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaed517a61b868769e2bfced40678be414">YAML_TAG_DIRECTIVE_TOKEN</a>, 54<br/> 55 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdabcafcdb506886387f93cca734ddfd670">YAML_DOCUMENT_START_TOKEN</a>, 56<br/> 57 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda8d0908a82229f44d5ea92a2c380f4579">YAML_DOCUMENT_END_TOKEN</a>, 58<br/> 59 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda4bfddc427da159168ee47267cbeea94f">YAML_BLOCK_SEQUENCE_START_TOKEN</a>, 60<br/> 61 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda9a95db99bd99f7f9b4e1e879106297dc">YAML_BLOCK_MAPPING_START_TOKEN</a>, 62<br/> 63 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda439948425097b4fc853f39f0de14a5ff">YAML_BLOCK_END_TOKEN</a>, 64<br/> 65 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda862a2390be4abd59bb7bf55b18d9260c">YAML_FLOW_SEQUENCE_START_TOKEN</a>, 66<br/> 67 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdab3496580bee30936f756e0102e98f331">YAML_FLOW_SEQUENCE_END_TOKEN</a>, 68<br/> 69 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaff68a3f7c000c5294211eef8f4156100">YAML_FLOW_MAPPING_START_TOKEN</a>, 70<br/> 71 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaad99bf47234572d9d0eeea7669d1e769">YAML_FLOW_MAPPING_END_TOKEN</a>, 72<br/> 73 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaa9bdf1d6da41fcd4d356c7bcfa0227b4">YAML_BLOCK_ENTRY_TOKEN</a>, 74<br/> 75 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaf11ab5655350e4cf0559f78382daa93f">YAML_FLOW_ENTRY_TOKEN</a>, 76<br/> 77 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda94d701c1f5bb8a392bb45b7cbf4bc2a5">YAML_KEY_TOKEN</a>, 78<br/> 79 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaac46e8a6a6e0614de322c7b53d785b4e">YAML_VALUE_TOKEN</a>, 80<br/> 81 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda080c398f6fc31f9ab35c7cf94cf948c2">YAML_ALIAS_TOKEN</a>, 82<br/> 83 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda7f0855938c5ccc4820b68ddd7985a5d0">YAML_ANCHOR_TOKEN</a>, 84<br/> 85 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda8f02c514b72f29bd3c26b7c832d8152d">YAML_TAG_TOKEN</a>, 86<br/> 87 <a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda107a78f31dd9857d06e9ead7936ea51e">YAML_SCALAR_TOKEN</a> 88<br/> 89 }</td></tr> 90<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Token types. </p> 91 <a href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">More...</a><br/></td></tr> 92<tr><td colspan="2"><h2><a name="func-members"></a> 93Functions</h2></td></tr> 94<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#ga3140131870e38e27f92a8fd286e5c004">yaml_token_delete</a> (<a class="el" href="structyaml__token__s.html">yaml_token_t</a> *token)</td></tr> 95<tr><td class="mdescLeft"> </td><td class="mdescRight">Free any memory allocated for a token object. <a href="#ga3140131870e38e27f92a8fd286e5c004"></a><br/></td></tr> 96</table> 97<hr/><h2>Typedef Documentation</h2> 98<a class="anchor" id="gaba51dda022dced02f8df2224ab7993f7"></a><!-- doxytag: member="yaml.h::yaml_token_type_t" ref="gaba51dda022dced02f8df2224ab7993f7" args="" --> 99<div class="memitem"> 100<div class="memproto"> 101 <table class="memname"> 102 <tr> 103 <td class="memname">typedef enum <a class="el" href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a> <a class="el" href="group__tokens.html#gaba51dda022dced02f8df2224ab7993f7">yaml_token_type_t</a></td> 104 </tr> 105 </table> 106</div> 107<div class="memdoc"> 108 109<p>Token types. </p> 110 111</div> 112</div> 113<a class="anchor" id="ga1ed3dc460e62aee8270c5d63d5734bbb"></a><!-- doxytag: member="yaml.h::yaml_token_t" ref="ga1ed3dc460e62aee8270c5d63d5734bbb" args="" --> 114<div class="memitem"> 115<div class="memproto"> 116 <table class="memname"> 117 <tr> 118 <td class="memname">typedef struct <a class="el" href="structyaml__token__s.html">yaml_token_s</a> <a class="el" href="structyaml__token__s.html">yaml_token_t</a></td> 119 </tr> 120 </table> 121</div> 122<div class="memdoc"> 123 124<p>The token structure. </p> 125 126</div> 127</div> 128<hr/><h2>Enumeration Type Documentation</h2> 129<a class="anchor" id="gaae955b10aa6b5f922de64873bf4ccdbd"></a><!-- doxytag: member="yaml.h::yaml_token_type_e" ref="gaae955b10aa6b5f922de64873bf4ccdbd" args="" --> 130<div class="memitem"> 131<div class="memproto"> 132 <table class="memname"> 133 <tr> 134 <td class="memname">enum <a class="el" href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a></td> 135 </tr> 136 </table> 137</div> 138<div class="memdoc"> 139 140<p>Token types. </p> 141<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 142<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda66c1b8eec0cc6402c0fb4b2d1b017f92"></a><!-- doxytag: member="YAML_NO_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda66c1b8eec0cc6402c0fb4b2d1b017f92" args="" -->YAML_NO_TOKEN</em> </td><td> 143<p>An empty token. </p> 144</td></tr> 145<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdaf5f42f2d5025e5629034848d2e1db6c9"></a><!-- doxytag: member="YAML_STREAM_START_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdaf5f42f2d5025e5629034848d2e1db6c9" args="" -->YAML_STREAM_START_TOKEN</em> </td><td> 146<p>A STREAM-START token. </p> 147</td></tr> 148<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda020a0a266ed7fc4902dd02750512dc19"></a><!-- doxytag: member="YAML_STREAM_END_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda020a0a266ed7fc4902dd02750512dc19" args="" -->YAML_STREAM_END_TOKEN</em> </td><td> 149<p>A STREAM-END token. </p> 150</td></tr> 151<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdaa15a96ec81c00c7db8f83628a89542e4"></a><!-- doxytag: member="YAML_VERSION_DIRECTIVE_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdaa15a96ec81c00c7db8f83628a89542e4" args="" -->YAML_VERSION_DIRECTIVE_TOKEN</em> </td><td> 152<p>A VERSION-DIRECTIVE token. </p> 153</td></tr> 154<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdaed517a61b868769e2bfced40678be414"></a><!-- doxytag: member="YAML_TAG_DIRECTIVE_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdaed517a61b868769e2bfced40678be414" args="" -->YAML_TAG_DIRECTIVE_TOKEN</em> </td><td> 155<p>A TAG-DIRECTIVE token. </p> 156</td></tr> 157<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdabcafcdb506886387f93cca734ddfd670"></a><!-- doxytag: member="YAML_DOCUMENT_START_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdabcafcdb506886387f93cca734ddfd670" args="" -->YAML_DOCUMENT_START_TOKEN</em> </td><td> 158<p>A DOCUMENT-START token. </p> 159</td></tr> 160<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda8d0908a82229f44d5ea92a2c380f4579"></a><!-- doxytag: member="YAML_DOCUMENT_END_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda8d0908a82229f44d5ea92a2c380f4579" args="" -->YAML_DOCUMENT_END_TOKEN</em> </td><td> 161<p>A DOCUMENT-END token. </p> 162</td></tr> 163<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda4bfddc427da159168ee47267cbeea94f"></a><!-- doxytag: member="YAML_BLOCK_SEQUENCE_START_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda4bfddc427da159168ee47267cbeea94f" args="" -->YAML_BLOCK_SEQUENCE_START_TOKEN</em> </td><td> 164<p>A BLOCK-SEQUENCE-START token. </p> 165</td></tr> 166<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda9a95db99bd99f7f9b4e1e879106297dc"></a><!-- doxytag: member="YAML_BLOCK_MAPPING_START_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda9a95db99bd99f7f9b4e1e879106297dc" args="" -->YAML_BLOCK_MAPPING_START_TOKEN</em> </td><td> 167<p>A BLOCK-SEQUENCE-END token. </p> 168</td></tr> 169<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda439948425097b4fc853f39f0de14a5ff"></a><!-- doxytag: member="YAML_BLOCK_END_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda439948425097b4fc853f39f0de14a5ff" args="" -->YAML_BLOCK_END_TOKEN</em> </td><td> 170<p>A BLOCK-END token. </p> 171</td></tr> 172<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda862a2390be4abd59bb7bf55b18d9260c"></a><!-- doxytag: member="YAML_FLOW_SEQUENCE_START_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda862a2390be4abd59bb7bf55b18d9260c" args="" -->YAML_FLOW_SEQUENCE_START_TOKEN</em> </td><td> 173<p>A FLOW-SEQUENCE-START token. </p> 174</td></tr> 175<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdab3496580bee30936f756e0102e98f331"></a><!-- doxytag: member="YAML_FLOW_SEQUENCE_END_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdab3496580bee30936f756e0102e98f331" args="" -->YAML_FLOW_SEQUENCE_END_TOKEN</em> </td><td> 176<p>A FLOW-SEQUENCE-END token. </p> 177</td></tr> 178<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdaff68a3f7c000c5294211eef8f4156100"></a><!-- doxytag: member="YAML_FLOW_MAPPING_START_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdaff68a3f7c000c5294211eef8f4156100" args="" -->YAML_FLOW_MAPPING_START_TOKEN</em> </td><td> 179<p>A FLOW-MAPPING-START token. </p> 180</td></tr> 181<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdaad99bf47234572d9d0eeea7669d1e769"></a><!-- doxytag: member="YAML_FLOW_MAPPING_END_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdaad99bf47234572d9d0eeea7669d1e769" args="" -->YAML_FLOW_MAPPING_END_TOKEN</em> </td><td> 182<p>A FLOW-MAPPING-END token. </p> 183</td></tr> 184<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdaa9bdf1d6da41fcd4d356c7bcfa0227b4"></a><!-- doxytag: member="YAML_BLOCK_ENTRY_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdaa9bdf1d6da41fcd4d356c7bcfa0227b4" args="" -->YAML_BLOCK_ENTRY_TOKEN</em> </td><td> 185<p>A BLOCK-ENTRY token. </p> 186</td></tr> 187<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdaf11ab5655350e4cf0559f78382daa93f"></a><!-- doxytag: member="YAML_FLOW_ENTRY_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdaf11ab5655350e4cf0559f78382daa93f" args="" -->YAML_FLOW_ENTRY_TOKEN</em> </td><td> 188<p>A FLOW-ENTRY token. </p> 189</td></tr> 190<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda94d701c1f5bb8a392bb45b7cbf4bc2a5"></a><!-- doxytag: member="YAML_KEY_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda94d701c1f5bb8a392bb45b7cbf4bc2a5" args="" -->YAML_KEY_TOKEN</em> </td><td> 191<p>A KEY token. </p> 192</td></tr> 193<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbdaac46e8a6a6e0614de322c7b53d785b4e"></a><!-- doxytag: member="YAML_VALUE_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbdaac46e8a6a6e0614de322c7b53d785b4e" args="" -->YAML_VALUE_TOKEN</em> </td><td> 194<p>A VALUE token. </p> 195</td></tr> 196<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda080c398f6fc31f9ab35c7cf94cf948c2"></a><!-- doxytag: member="YAML_ALIAS_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda080c398f6fc31f9ab35c7cf94cf948c2" args="" -->YAML_ALIAS_TOKEN</em> </td><td> 197<p>An ALIAS token. </p> 198</td></tr> 199<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda7f0855938c5ccc4820b68ddd7985a5d0"></a><!-- doxytag: member="YAML_ANCHOR_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda7f0855938c5ccc4820b68ddd7985a5d0" args="" -->YAML_ANCHOR_TOKEN</em> </td><td> 200<p>An ANCHOR token. </p> 201</td></tr> 202<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda8f02c514b72f29bd3c26b7c832d8152d"></a><!-- doxytag: member="YAML_TAG_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda8f02c514b72f29bd3c26b7c832d8152d" args="" -->YAML_TAG_TOKEN</em> </td><td> 203<p>A TAG token. </p> 204</td></tr> 205<tr><td valign="top"><em><a class="anchor" id="ggaae955b10aa6b5f922de64873bf4ccdbda107a78f31dd9857d06e9ead7936ea51e"></a><!-- doxytag: member="YAML_SCALAR_TOKEN" ref="ggaae955b10aa6b5f922de64873bf4ccdbda107a78f31dd9857d06e9ead7936ea51e" args="" -->YAML_SCALAR_TOKEN</em> </td><td> 206<p>A SCALAR token. </p> 207</td></tr> 208</table> 209</dd> 210</dl> 211 212</div> 213</div> 214<hr/><h2>Function Documentation</h2> 215<a class="anchor" id="ga3140131870e38e27f92a8fd286e5c004"></a><!-- doxytag: member="yaml.h::yaml_token_delete" ref="ga3140131870e38e27f92a8fd286e5c004" args="(yaml_token_t *token)" --> 216<div class="memitem"> 217<div class="memproto"> 218 <table class="memname"> 219 <tr> 220 <td class="memname">void yaml_token_delete </td> 221 <td>(</td> 222 <td class="paramtype"><a class="el" href="structyaml__token__s.html">yaml_token_t</a> * </td> 223 <td class="paramname"> <em>token</em></td> 224 <td> ) </td> 225 <td></td> 226 </tr> 227 </table> 228</div> 229<div class="memdoc"> 230 231<p>Free any memory allocated for a token object. </p> 232<dl><dt><b>Parameters:</b></dt><dd> 233 <table border="0" cellspacing="2" cellpadding="0"> 234 <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>token</em> </td><td>A token object. </td></tr> 235 </table> 236 </dd> 237</dl> 238 239</div> 240</div> 241</div> 242<hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by 243<a href="http://www.doxygen.org/index.html"> 244<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> 245</body> 246</html> 247
