forked from Mirrors/freeswitch
183 lines
15 KiB
HTML
183 lines
15 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||
|
<title>yaml: Tokens</title>
|
||
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
||
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
||
|
</head><body>
|
||
|
<!-- Generated by Doxygen 1.5.1 -->
|
||
|
<div class="tabs">
|
||
|
<ul>
|
||
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
||
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
||
|
<li><a href="files.html"><span>Files</span></a></li>
|
||
|
</ul></div>
|
||
|
<h1>Tokens</h1><table border="0" cellpadding="0" cellspacing="0">
|
||
|
<tr><td></td></tr>
|
||
|
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
|
||
|
<tr><td class="memItemLeft" nowrap 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>
|
||
|
|
||
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The token structure. <a href="structyaml__token__s.html#_details">More...</a><br></td></tr>
|
||
|
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
|
||
|
<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="" -->
|
||
|
typedef enum <a class="el" href="group__tokens.html#gae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#gba51dda022dced02f8df2224ab7993f7">yaml_token_type_t</a></td></tr>
|
||
|
|
||
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Token types. <br></td></tr>
|
||
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1ed3dc460e62aee8270c5d63d5734bbb"></a><!-- doxytag: member="tokens::yaml_token_t" ref="g1ed3dc460e62aee8270c5d63d5734bbb" args="" -->
|
||
|
typedef <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#g1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a></td></tr>
|
||
|
|
||
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The token structure. <br></td></tr>
|
||
|
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
|
||
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#gae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a> { <br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd66c1b8eec0cc6402c0fb4b2d1b017f92">YAML_NO_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdf5f42f2d5025e5629034848d2e1db6c9">YAML_STREAM_START_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd020a0a266ed7fc4902dd02750512dc19">YAML_STREAM_END_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbda15a96ec81c00c7db8f83628a89542e4">YAML_VERSION_DIRECTIVE_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbded517a61b868769e2bfced40678be414">YAML_TAG_DIRECTIVE_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdbcafcdb506886387f93cca734ddfd670">YAML_DOCUMENT_START_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd8d0908a82229f44d5ea92a2c380f4579">YAML_DOCUMENT_END_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd4bfddc427da159168ee47267cbeea94f">YAML_BLOCK_SEQUENCE_START_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd9a95db99bd99f7f9b4e1e879106297dc">YAML_BLOCK_MAPPING_START_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd439948425097b4fc853f39f0de14a5ff">YAML_BLOCK_END_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd862a2390be4abd59bb7bf55b18d9260c">YAML_FLOW_SEQUENCE_START_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdb3496580bee30936f756e0102e98f331">YAML_FLOW_SEQUENCE_END_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdff68a3f7c000c5294211eef8f4156100">YAML_FLOW_MAPPING_START_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdad99bf47234572d9d0eeea7669d1e769">YAML_FLOW_MAPPING_END_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbda9bdf1d6da41fcd4d356c7bcfa0227b4">YAML_BLOCK_ENTRY_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdf11ab5655350e4cf0559f78382daa93f">YAML_FLOW_ENTRY_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd94d701c1f5bb8a392bb45b7cbf4bc2a5">YAML_KEY_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbdac46e8a6a6e0614de322c7b53d785b4e">YAML_VALUE_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd080c398f6fc31f9ab35c7cf94cf948c2">YAML_ALIAS_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd7f0855938c5ccc4820b68ddd7985a5d0">YAML_ANCHOR_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd8f02c514b72f29bd3c26b7c832d8152d">YAML_TAG_TOKEN</a>,
|
||
|
<br>
|
||
|
<a class="el" href="group__tokens.html#ggae955b10aa6b5f922de64873bf4ccdbd107a78f31dd9857d06e9ead7936ea51e">YAML_SCALAR_TOKEN</a>
|
||
|
<br>
|
||
|
}</td></tr>
|
||
|
|
||
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Token types. <a href="group__tokens.html#gae955b10aa6b5f922de64873bf4ccdbd">More...</a><br></td></tr>
|
||
|
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
||
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </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>
|
||
|
|
||
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free any memory allocated for a token object. <a href="#g3140131870e38e27f92a8fd286e5c004"></a><br></td></tr>
|
||
|
</table>
|
||
|
<hr><h2>Enumeration Type Documentation</h2>
|
||
|
<a class="anchor" name="gae955b10aa6b5f922de64873bf4ccdbd"></a><!-- doxytag: member="yaml.h::yaml_token_type_e" ref="gae955b10aa6b5f922de64873bf4ccdbd" args="" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">enum <a class="el" href="group__tokens.html#gae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a> </td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
|
||
|
<p>
|
||
|
Token types.
|
||
|
<p>
|
||
|
<dl compact><dt><b>Enumerator: </b></dt><dd>
|
||
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd66c1b8eec0cc6402c0fb4b2d1b017f92"></a><!-- doxytag: member="YAML_NO_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd66c1b8eec0cc6402c0fb4b2d1b017f92" args="" -->YAML_NO_TOKEN</em> </td><td>
|
||
|
An empty token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A STREAM-START token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A STREAM-END token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A VERSION-DIRECTIVE token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A TAG-DIRECTIVE token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A DOCUMENT-START token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A DOCUMENT-END token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A BLOCK-SEQUENCE-START token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A BLOCK-SEQUENCE-END token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A BLOCK-END token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A FLOW-SEQUENCE-START token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A FLOW-SEQUENCE-END token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A FLOW-MAPPING-START token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A FLOW-MAPPING-END token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A BLOCK-ENTRY token. </td></tr>
|
||
|
<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> </td><td>
|
||
|
A FLOW-ENTRY token. </td></tr>
|
||
|
<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd94d701c1f5bb8a392bb45b7cbf4bc2a5"></a><!-- doxytag: member="YAML_KEY_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd94d701c1f5bb8a392bb45b7cbf4bc2a5" args="" -->YAML_KEY_TOKEN</em> </td><td>
|
||
|
A KEY token. </td></tr>
|
||
|
<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbdac46e8a6a6e0614de322c7b53d785b4e"></a><!-- doxytag: member="YAML_VALUE_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbdac46e8a6a6e0614de322c7b53d785b4e" args="" -->YAML_VALUE_TOKEN</em> </td><td>
|
||
|
A VALUE token. </td></tr>
|
||
|
<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd080c398f6fc31f9ab35c7cf94cf948c2"></a><!-- doxytag: member="YAML_ALIAS_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd080c398f6fc31f9ab35c7cf94cf948c2" args="" -->YAML_ALIAS_TOKEN</em> </td><td>
|
||
|
An ALIAS token. </td></tr>
|
||
|
<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd7f0855938c5ccc4820b68ddd7985a5d0"></a><!-- doxytag: member="YAML_ANCHOR_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd7f0855938c5ccc4820b68ddd7985a5d0" args="" -->YAML_ANCHOR_TOKEN</em> </td><td>
|
||
|
An ANCHOR token. </td></tr>
|
||
|
<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd8f02c514b72f29bd3c26b7c832d8152d"></a><!-- doxytag: member="YAML_TAG_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd8f02c514b72f29bd3c26b7c832d8152d" args="" -->YAML_TAG_TOKEN</em> </td><td>
|
||
|
A TAG token. </td></tr>
|
||
|
<tr><td valign="top"><em><a class="anchor" name="ggae955b10aa6b5f922de64873bf4ccdbd107a78f31dd9857d06e9ead7936ea51e"></a><!-- doxytag: member="YAML_SCALAR_TOKEN" ref="ggae955b10aa6b5f922de64873bf4ccdbd107a78f31dd9857d06e9ead7936ea51e" args="" -->YAML_SCALAR_TOKEN</em> </td><td>
|
||
|
A SCALAR token. </td></tr>
|
||
|
</table>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div><p>
|
||
|
<hr><h2>Function Documentation</h2>
|
||
|
<a class="anchor" name="g3140131870e38e27f92a8fd286e5c004"></a><!-- doxytag: member="yaml.h::yaml_token_delete" ref="g3140131870e38e27f92a8fd286e5c004" args="(yaml_token_t *token)" -->
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void yaml_token_delete </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="structyaml__token__s.html">yaml_token_t</a> * </td>
|
||
|
<td class="paramname"> <em>token</em> </td>
|
||
|
<td> ) </td>
|
||
|
<td width="100%"></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div>
|
||
|
<div class="memdoc">
|
||
|
|
||
|
<p>
|
||
|
Free any memory allocated for a token object.
|
||
|
<p>
|
||
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>token</em> </td><td>A token object. </td></tr>
|
||
|
</table>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div><p>
|
||
|
<hr size="1"><address style="align: right;"><small>Generated on Thu May 31 22:50:59 2007 for yaml by
|
||
|
<a href="http://www.doxygen.org/index.html">
|
||
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
|
||
|
</body>
|
||
|
</html>
|