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