doc/html/group__tokens.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.14"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>yaml: Tokens</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">yaml
  22    &#160;<span id="projectnumber">0.2.1</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.14 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Data Structures</a> &#124;
  44 <a href="#typedef-members">Typedefs</a> &#124;
  45 <a href="#enum-members">Enumerations</a> &#124;
  46 <a href="#func-members">Functions</a>  </div>
  47   <div class="headertitle">
  48 <div class="title">Tokens</div>  </div>
  49 </div><!--header-->
  50 <div class="contents">
  51 <table class="memberdecls">
  52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  53 Data Structures</h2></td></tr>
  54 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__token__s.html">yaml_token_s</a></td></tr>
  55 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The token structure.  <a href="structyaml__token__s.html#details">More...</a><br /></td></tr>
  56 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57 </table><table class="memberdecls">
  58 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  59 Typedefs</h2></td></tr>
  60 <tr class="memitem:gaba51dda022dced02f8df2224ab7993f7"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#gaba51dda022dced02f8df2224ab7993f7">yaml_token_type_t</a></td></tr>
  61 <tr class="memdesc:gaba51dda022dced02f8df2224ab7993f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Token types.  <a href="#gaba51dda022dced02f8df2224ab7993f7">More...</a><br /></td></tr>
  62 <tr class="separator:gaba51dda022dced02f8df2224ab7993f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 <tr class="memitem:ga1ed3dc460e62aee8270c5d63d5734bbb"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__token__s.html">yaml_token_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a></td></tr>
  64 <tr class="memdesc:ga1ed3dc460e62aee8270c5d63d5734bbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The token structure.  <a href="#ga1ed3dc460e62aee8270c5d63d5734bbb">More...</a><br /></td></tr>
  65 <tr class="separator:ga1ed3dc460e62aee8270c5d63d5734bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 </table><table class="memberdecls">
  67 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  68 Enumerations</h2></td></tr>
  69 <tr class="memitem:gaae955b10aa6b5f922de64873bf4ccdbd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a> { <br />
  70 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda66c1b8eec0cc6402c0fb4b2d1b017f92">YAML_NO_TOKEN</a>,
  71 <br />
  72 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaf5f42f2d5025e5629034848d2e1db6c9">YAML_STREAM_START_TOKEN</a>,
  73 <br />
  74 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda020a0a266ed7fc4902dd02750512dc19">YAML_STREAM_END_TOKEN</a>,
  75 <br />
  76 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaa15a96ec81c00c7db8f83628a89542e4">YAML_VERSION_DIRECTIVE_TOKEN</a>,
  77 <br />
  78 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaed517a61b868769e2bfced40678be414">YAML_TAG_DIRECTIVE_TOKEN</a>,
  79 <br />
  80 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdabcafcdb506886387f93cca734ddfd670">YAML_DOCUMENT_START_TOKEN</a>,
  81 <br />
  82 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda8d0908a82229f44d5ea92a2c380f4579">YAML_DOCUMENT_END_TOKEN</a>,
  83 <br />
  84 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda4bfddc427da159168ee47267cbeea94f">YAML_BLOCK_SEQUENCE_START_TOKEN</a>,
  85 <br />
  86 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda9a95db99bd99f7f9b4e1e879106297dc">YAML_BLOCK_MAPPING_START_TOKEN</a>,
  87 <br />
  88 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda439948425097b4fc853f39f0de14a5ff">YAML_BLOCK_END_TOKEN</a>,
  89 <br />
  90 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda862a2390be4abd59bb7bf55b18d9260c">YAML_FLOW_SEQUENCE_START_TOKEN</a>,
  91 <br />
  92 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdab3496580bee30936f756e0102e98f331">YAML_FLOW_SEQUENCE_END_TOKEN</a>,
  93 <br />
  94 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaff68a3f7c000c5294211eef8f4156100">YAML_FLOW_MAPPING_START_TOKEN</a>,
  95 <br />
  96 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaad99bf47234572d9d0eeea7669d1e769">YAML_FLOW_MAPPING_END_TOKEN</a>,
  97 <br />
  98 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaa9bdf1d6da41fcd4d356c7bcfa0227b4">YAML_BLOCK_ENTRY_TOKEN</a>,
  99 <br />
 100 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaf11ab5655350e4cf0559f78382daa93f">YAML_FLOW_ENTRY_TOKEN</a>,
 101 <br />
 102 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda94d701c1f5bb8a392bb45b7cbf4bc2a5">YAML_KEY_TOKEN</a>,
 103 <br />
 104 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbdaac46e8a6a6e0614de322c7b53d785b4e">YAML_VALUE_TOKEN</a>,
 105 <br />
 106 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda080c398f6fc31f9ab35c7cf94cf948c2">YAML_ALIAS_TOKEN</a>,
 107 <br />
 108 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda7f0855938c5ccc4820b68ddd7985a5d0">YAML_ANCHOR_TOKEN</a>,
 109 <br />
 110 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda8f02c514b72f29bd3c26b7c832d8152d">YAML_TAG_TOKEN</a>,
 111 <br />
 112 &#160;&#160;<a class="el" href="group__tokens.html#ggaae955b10aa6b5f922de64873bf4ccdbda107a78f31dd9857d06e9ead7936ea51e">YAML_SCALAR_TOKEN</a>
 113 <br />
 114  }</td></tr>
 115 <tr class="memdesc:gaae955b10aa6b5f922de64873bf4ccdbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Token types.  <a href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">More...</a><br /></td></tr>
 116 <tr class="separator:gaae955b10aa6b5f922de64873bf4ccdbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 117 </table><table class="memberdecls">
 118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 119 Functions</h2></td></tr>
 120 <tr class="memitem:ga3140131870e38e27f92a8fd286e5c004"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokens.html#ga3140131870e38e27f92a8fd286e5c004">yaml_token_delete</a> (<a class="el" href="group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a> *token)</td></tr>
 121 <tr class="memdesc:ga3140131870e38e27f92a8fd286e5c004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free any memory allocated for a token object.  <a href="#ga3140131870e38e27f92a8fd286e5c004">More...</a><br /></td></tr>
 122 <tr class="separator:ga3140131870e38e27f92a8fd286e5c004"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 </table>
 124 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 125 <h2 class="groupheader">Typedef Documentation</h2>
 126 <a id="gaba51dda022dced02f8df2224ab7993f7"></a>
 127 <h2 class="memtitle"><span class="permalink"><a href="#gaba51dda022dced02f8df2224ab7993f7">&#9670;&nbsp;</a></span>yaml_token_type_t</h2>
 128
 129 <div class="memitem">
 130 <div class="memproto">
 131       <table class="memname">
 132         <tr>
 133           <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>
 134         </tr>
 135       </table>
 136 </div><div class="memdoc">
 137
 138 <p>Token types. </p>
 139
 140 </div>
 141 </div>
 142 <a id="ga1ed3dc460e62aee8270c5d63d5734bbb"></a>
 143 <h2 class="memtitle"><span class="permalink"><a href="#ga1ed3dc460e62aee8270c5d63d5734bbb">&#9670;&nbsp;</a></span>yaml_token_t</h2>
 144
 145 <div class="memitem">
 146 <div class="memproto">
 147       <table class="memname">
 148         <tr>
 149           <td class="memname">typedef struct <a class="el" href="structyaml__token__s.html">yaml_token_s</a>  <a class="el" href="group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a></td>
 150         </tr>
 151       </table>
 152 </div><div class="memdoc">
 153
 154 <p>The token structure. </p>
 155
 156 </div>
 157 </div>
 158 <h2 class="groupheader">Enumeration Type Documentation</h2>
 159 <a id="gaae955b10aa6b5f922de64873bf4ccdbd"></a>
 160 <h2 class="memtitle"><span class="permalink"><a href="#gaae955b10aa6b5f922de64873bf4ccdbd">&#9670;&nbsp;</a></span>yaml_token_type_e</h2>
 161
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname">enum <a class="el" href="group__tokens.html#gaae955b10aa6b5f922de64873bf4ccdbd">yaml_token_type_e</a></td>
 167         </tr>
 168       </table>
 169 </div><div class="memdoc">
 170
 171 <p>Token types. </p>
 172 <table class="fieldtable">
 173 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda66c1b8eec0cc6402c0fb4b2d1b017f92"></a>YAML_NO_TOKEN&#160;</td><td class="fielddoc"><p>An empty token. </p>
 174 </td></tr>
 175 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdaf5f42f2d5025e5629034848d2e1db6c9"></a>YAML_STREAM_START_TOKEN&#160;</td><td class="fielddoc"><p>A STREAM-START token. </p>
 176 </td></tr>
 177 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda020a0a266ed7fc4902dd02750512dc19"></a>YAML_STREAM_END_TOKEN&#160;</td><td class="fielddoc"><p>A STREAM-END token. </p>
 178 </td></tr>
 179 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdaa15a96ec81c00c7db8f83628a89542e4"></a>YAML_VERSION_DIRECTIVE_TOKEN&#160;</td><td class="fielddoc"><p>A VERSION-DIRECTIVE token. </p>
 180 </td></tr>
 181 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdaed517a61b868769e2bfced40678be414"></a>YAML_TAG_DIRECTIVE_TOKEN&#160;</td><td class="fielddoc"><p>A TAG-DIRECTIVE token. </p>
 182 </td></tr>
 183 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdabcafcdb506886387f93cca734ddfd670"></a>YAML_DOCUMENT_START_TOKEN&#160;</td><td class="fielddoc"><p>A DOCUMENT-START token. </p>
 184 </td></tr>
 185 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda8d0908a82229f44d5ea92a2c380f4579"></a>YAML_DOCUMENT_END_TOKEN&#160;</td><td class="fielddoc"><p>A DOCUMENT-END token. </p>
 186 </td></tr>
 187 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda4bfddc427da159168ee47267cbeea94f"></a>YAML_BLOCK_SEQUENCE_START_TOKEN&#160;</td><td class="fielddoc"><p>A BLOCK-SEQUENCE-START token. </p>
 188 </td></tr>
 189 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda9a95db99bd99f7f9b4e1e879106297dc"></a>YAML_BLOCK_MAPPING_START_TOKEN&#160;</td><td class="fielddoc"><p>A BLOCK-SEQUENCE-END token. </p>
 190 </td></tr>
 191 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda439948425097b4fc853f39f0de14a5ff"></a>YAML_BLOCK_END_TOKEN&#160;</td><td class="fielddoc"><p>A BLOCK-END token. </p>
 192 </td></tr>
 193 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda862a2390be4abd59bb7bf55b18d9260c"></a>YAML_FLOW_SEQUENCE_START_TOKEN&#160;</td><td class="fielddoc"><p>A FLOW-SEQUENCE-START token. </p>
 194 </td></tr>
 195 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdab3496580bee30936f756e0102e98f331"></a>YAML_FLOW_SEQUENCE_END_TOKEN&#160;</td><td class="fielddoc"><p>A FLOW-SEQUENCE-END token. </p>
 196 </td></tr>
 197 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdaff68a3f7c000c5294211eef8f4156100"></a>YAML_FLOW_MAPPING_START_TOKEN&#160;</td><td class="fielddoc"><p>A FLOW-MAPPING-START token. </p>
 198 </td></tr>
 199 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdaad99bf47234572d9d0eeea7669d1e769"></a>YAML_FLOW_MAPPING_END_TOKEN&#160;</td><td class="fielddoc"><p>A FLOW-MAPPING-END token. </p>
 200 </td></tr>
 201 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdaa9bdf1d6da41fcd4d356c7bcfa0227b4"></a>YAML_BLOCK_ENTRY_TOKEN&#160;</td><td class="fielddoc"><p>A BLOCK-ENTRY token. </p>
 202 </td></tr>
 203 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdaf11ab5655350e4cf0559f78382daa93f"></a>YAML_FLOW_ENTRY_TOKEN&#160;</td><td class="fielddoc"><p>A FLOW-ENTRY token. </p>
 204 </td></tr>
 205 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda94d701c1f5bb8a392bb45b7cbf4bc2a5"></a>YAML_KEY_TOKEN&#160;</td><td class="fielddoc"><p>A KEY token. </p>
 206 </td></tr>
 207 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbdaac46e8a6a6e0614de322c7b53d785b4e"></a>YAML_VALUE_TOKEN&#160;</td><td class="fielddoc"><p>A VALUE token. </p>
 208 </td></tr>
 209 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda080c398f6fc31f9ab35c7cf94cf948c2"></a>YAML_ALIAS_TOKEN&#160;</td><td class="fielddoc"><p>An ALIAS token. </p>
 210 </td></tr>
 211 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda7f0855938c5ccc4820b68ddd7985a5d0"></a>YAML_ANCHOR_TOKEN&#160;</td><td class="fielddoc"><p>An ANCHOR token. </p>
 212 </td></tr>
 213 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda8f02c514b72f29bd3c26b7c832d8152d"></a>YAML_TAG_TOKEN&#160;</td><td class="fielddoc"><p>A TAG token. </p>
 214 </td></tr>
 215 <tr><td class="fieldname"><a id="ggaae955b10aa6b5f922de64873bf4ccdbda107a78f31dd9857d06e9ead7936ea51e"></a>YAML_SCALAR_TOKEN&#160;</td><td class="fielddoc"><p>A SCALAR token. </p>
 216 </td></tr>
 217 </table>
 218
 219 </div>
 220 </div>
 221 <h2 class="groupheader">Function Documentation</h2>
 222 <a id="ga3140131870e38e27f92a8fd286e5c004"></a>
 223 <h2 class="memtitle"><span class="permalink"><a href="#ga3140131870e38e27f92a8fd286e5c004">&#9670;&nbsp;</a></span>yaml_token_delete()</h2>
 224
 225 <div class="memitem">
 226 <div class="memproto">
 227       <table class="memname">
 228         <tr>
 229           <td class="memname">void yaml_token_delete </td>
 230           <td>(</td>
 231           <td class="paramtype"><a class="el" href="group__tokens.html#ga1ed3dc460e62aee8270c5d63d5734bbb">yaml_token_t</a> *&#160;</td>
 232           <td class="paramname"><em>token</em></td><td>)</td>
 233           <td></td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237
 238 <p>Free any memory allocated for a token object. </p>
 239 <dl class="params"><dt>Parameters</dt><dd>
 240   <table class="params">
 241     <tr><td class="paramdir">[in,out]</td><td class="paramname">token</td><td>A token object. </td></tr>
 242   </table>
 243   </dd>
 244 </dl>
 245
 246 </div>
 247 </div>
 248 </div><!-- contents -->
 249 <!-- start footer part -->
 250 <hr class="footer"/><address class="footer"><small>
 251 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 252 <img class="footer" src="doxygen.png" alt="doxygen"/>
 253 </a> 1.8.14
 254 </small></address>
 255 </body>
 256 </html>