<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ANTLR3C: include/antlr3commontoken.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ANTLR3C <span id="projectnumber">3.1.2</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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 class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('antlr3commontoken_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<h1>antlr3commontoken.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Defines the interface for a common token.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="antlr3defs_8h.html">antlr3defs.h</a>></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for antlr3commontoken.h:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3commontoken_8h__incl.png" border="0" usemap="#include_2antlr3commontoken_8h" alt=""/></div>
<map name="include_2antlr3commontoken_8h" id="include_2antlr3commontoken_8h">
<area shape="rect" id="node3" href="antlr3defs_8h.html" title="Basic type and constant definitions for ANTLR3 Runtime." alt="" coords="439,80,580,107"/><area shape="rect" id="node5" href="antlr3errors_8h.html" title="antlr3errors.h" alt="" coords="5,155,168,181"/><area shape="rect" id="node11" href="antlr3interfaces_8h.html" title="Declarations for all the antlr3 C runtime interfaces/classes." alt="" coords="493,155,696,181"/><area shape="rect" id="node13" href="antlr3convertutf_8h.html" title="antlr3convertutf.h" alt="" coords="720,155,923,181"/></map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3commontoken_8h__dep__incl.png" border="0" usemap="#include_2antlr3commontoken_8hdep" alt=""/></div>
<map name="include_2antlr3commontoken_8hdep" id="include_2antlr3commontoken_8hdep">
<area shape="rect" id="node3" href="antlr3_8h.html" title="include/antlr3.h" alt="" coords="1184,528,1365,555"/><area shape="rect" id="node5" href="antlr3baserecognizer_8h.html" title="Defines the basic structure to support recognizing by either a lexer, parser, or tree parser..." alt="" coords="973,379,1296,405"/><area shape="rect" id="node11" href="antlr3lexer_8h.html" title="Base interface for any ANTLR3 lexer." alt="" coords="1627,453,1859,480"/><area shape="rect" id="node25" href="antlr3basetreeadaptor_8h.html" title="Definition of the ANTLR3 base tree adaptor." alt="" coords="5,155,336,181"/><area shape="rect" id="node36" href="antlr3commontree_8h.html" title="include/antlr3commontree.h" alt="" coords="653,155,936,181"/><area shape="rect" id="node40" href="antlr3debugeventlistener_8h.html" title="The definition of all debugging events that a recognizer can trigger." alt="" coords="481,80,844,107"/><area shape="rect" id="node46" href="antlr3tokenstream_8h.html" title="Defines the interface for an ANTLR3 common token stream." alt="" coords="1263,304,1553,331"/><area shape="rect" id="node51" href="antlr3input_8h.html" title="Defines the basic structures used to manipulate character streams from any input source." alt="" coords="1627,229,1859,256"/><area shape="rect" id="node57" href="antlr3intstream_8h.html" title="Defines the the class interface for an antlr3 INTSTREAM." alt="" coords="1440,155,1712,181"/><area shape="rect" id="node8" href="antlr3cyclicdfa_8h.html" title="include/antlr3cyclicdfa.h" alt="" coords="1280,453,1552,480"/><area shape="rect" id="node15" href="antlr3parser_8h.html" title="Base implementation of an ANTLR3 parser." alt="" coords="1013,453,1256,480"/><area shape="rect" id="node19" href="antlr3rewritestreams_8h.html" title="include/antlr3rewritestreams.h" alt="" coords="309,453,632,480"/><area shape="rect" id="node22" href="antlr3treeparser_8h.html" title="include/antlr3treeparser.h" alt="" coords="656,453,939,480"/><area shape="rect" id="node28" href="antlr3commontreeadaptor_8h.html" title="Definition of the ANTLR3 common tree adaptor." alt="" coords="349,229,701,256"/><area shape="rect" id="node31" href="antlr3commontreenodestream_8h.html" title="Definition of the ANTLR3 common tree node stream." alt="" coords="604,304,985,331"/></map>
</div>
</div><table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n__struct.html">ANTLR3_COMMON_TOKEN_struct</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The definition of an ANTLR3 common token structure, which all implementations of a token stream should provide, installing any further structures in the custom pointer element of this structure. <a href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n__struct.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___t_o_k_e_n___f_a_c_t_o_r_y__struct.html">ANTLR3_TOKEN_FACTORY_struct</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ANTLR3 Token factory interface to create lots of tokens efficiently rather than creating and freeing lots of little bits of memory. <a href="struct_a_n_t_l_r3___t_o_k_e_n___f_a_c_t_o_r_y__struct.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a6769d1690b4e65d57efcea32754f1e79">ANTLR3_EOR_TOKEN_TYPE</a>   1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#ad3289834d75e3f178c70dd789feecf65">ANTLR3_FACTORY_POOL_SIZE</a>   1024</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">How many tokens to allocate at once in the token factory. <a href="#ad3289834d75e3f178c70dd789feecf65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a24abe14d00c052444bfeae9ee89633dd">ANTLR3_MIN_TOKEN_TYPE</a>   ANTLR3_TOKEN_UP + 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">First token that can be used by users/generated code. <a href="#a24abe14d00c052444bfeae9ee89633dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a18e96db5f2e36738c75cf8b7f7f4b9b5">ANTLR3_TEXT_CHARP</a>   1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a12483b449f9b0bc7f58559ca2c49f5f1">ANTLR3_TEXT_NONE</a>   0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a3ab0ac4c534deda43606fa1161f4452e">ANTLR3_TEXT_STRING</a>   2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a9c3c0f56aca416d3c5b5334bb2f5857c">ANTLR3_TOKEN_DEFAULT_CHANNEL</a>   0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default channel for a token. <a href="#a9c3c0f56aca416d3c5b5334bb2f5857c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a603c0885903dbf262788c91f26101ae2">ANTLR3_TOKEN_DOWN</a>   2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Imaginary token type to cause a traversal of child nodes in a tree parser. <a href="#a603c0885903dbf262788c91f26101ae2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a1c8f8ac4a421a4adcad0c827fb4f91cd">ANTLR3_TOKEN_EOF</a>   (ANTLR3_CHARSTREAM_EOF & 0xFFFFFFFF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End of file token. <a href="#a1c8f8ac4a421a4adcad0c827fb4f91cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#ae6add32e4a00e4a514491188b60196e0">ANTLR3_TOKEN_INVALID</a>   0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicator of an invalid token. <a href="#ae6add32e4a00e4a514491188b60196e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#a0fe56e2df2fa8c65e2fba3a79b8af043">ANTLR3_TOKEN_UP</a>   3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Imaginary token type to signal the end of a stream of child nodes. <a href="#a0fe56e2df2fa8c65e2fba3a79b8af043"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#ab42ef41116f8f2fe447484e2844cf0df">HIDDEN</a>   99</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reserved channel number for a HIDDEN token - a token that is hidden from the parser. <a href="#ab42ef41116f8f2fe447484e2844cf0df"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n__struct.html">ANTLR3_COMMON_TOKEN_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#ab35c5fc3921ac6bfa1dbb31681aa9a0f">ANTLR3_COMMON_TOKEN</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The definition of an ANTLR3 common token structure, which all implementations of a token stream should provide, installing any further structures in the custom pointer element of this structure. <a href="#ab35c5fc3921ac6bfa1dbb31681aa9a0f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="struct_a_n_t_l_r3___t_o_k_e_n___f_a_c_t_o_r_y__struct.html">ANTLR3_TOKEN_FACTORY_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3commontoken_8h.html#ae1962da0aae7400046a52818b5e7374d">ANTLR3_TOKEN_FACTORY</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ANTLR3 Token factory interface to create lots of tokens efficiently rather than creating and freeing lots of little bits of memory. <a href="#ae1962da0aae7400046a52818b5e7374d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines the interface for a common token. </p>
<p>All token streams should provide their tokens using an instance of this common token. A custom pointer is provided, wher you may attach a further structure to enhance the common token if you feel the need to do so. The C runtime will assume that a token provides implementations of the interface functions, but all of them may be rplaced by your own implementation if you require it. </p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a6769d1690b4e65d57efcea32754f1e79"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_EOR_TOKEN_TYPE" ref="a6769d1690b4e65d57efcea32754f1e79" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_EOR_TOKEN_TYPE   1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#gaae6c6fbbbf2e1c74b612c56585421480">combineFollows()</a>, <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#gaae2cb5c900551876f8ba170252b9a73b">mismatchIsMissingToken()</a>, and <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga733153563bd70d3b65fce9bd665fb61f">recoverFromMismatchedElement()</a>.</p>
</div>
</div>
<a class="anchor" id="ad3289834d75e3f178c70dd789feecf65"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_FACTORY_POOL_SIZE" ref="ad3289834d75e3f178c70dd789feecf65" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_FACTORY_POOL_SIZE   1024</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>How many tokens to allocate at once in the token factory. </p>
<p>Referenced by <a class="el" href="antlr3commontoken_8c.html#a138055a9dcffd2bccf6cb8a47053ae0c">factoryClose()</a>, <a class="el" href="antlr3commontoken_8c.html#afbb6dd57f37eaaafc4dbadce8f3f77f0">newPool()</a>, <a class="el" href="antlr3commontoken_8c.html#afa0c747a497553a3b1f7508bcbba22fd">newPoolToken()</a>, and <a class="el" href="antlr3commontree_8c.html#a108253520363014dfbdaf22f65f83275">newPoolTree()</a>.</p>
</div>
</div>
<a class="anchor" id="a24abe14d00c052444bfeae9ee89633dd"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_MIN_TOKEN_TYPE" ref="a24abe14d00c052444bfeae9ee89633dd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_MIN_TOKEN_TYPE   ANTLR3_TOKEN_UP + 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>First token that can be used by users/generated code. </p>
</div>
</div>
<a class="anchor" id="a18e96db5f2e36738c75cf8b7f7f4b9b5"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TEXT_CHARP" ref="a18e96db5f2e36738c75cf8b7f7f4b9b5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_TEXT_CHARP   1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="antlr3defs_8h.html#af53a0945d04dc72b9a3b927c1fa5ffd7">antlr3CommonTreeNodeStreamNew()</a>, <a class="el" href="antlr3commontreeadaptor_8c.html#a66ba1309bf5560155b44f361cab4898e">createToken()</a>, <a class="el" href="antlr3commontreeadaptor_8c.html#a359e4d8f1cb4b8e5f3c37aefe005223f">createTokenFromToken()</a>, <a class="el" href="antlr3commontoken_8c.html#aec920b285c989ea0d7d4d926899cf767">getText()</a>, <a class="el" href="antlr3commontreenodestream_8c.html#a404d1d946e8d99139eb862d7c571e9dc">newDownNode()</a>, <a class="el" href="antlr3commontreenodestream_8c.html#aba2a1070fb666dd0aa01b84610ee41eb">newUpNode()</a>, and <a class="el" href="antlr3commontoken_8c.html#a38b67f15c616153efe0f8010eb17fe91">setText8()</a>.</p>
</div>
</div>
<a class="anchor" id="a12483b449f9b0bc7f58559ca2c49f5f1"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TEXT_NONE" ref="a12483b449f9b0bc7f58559ca2c49f5f1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_TEXT_NONE   0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="antlr3defs_8h.html#ad6214ed38e124f2ada5b7056c15b58dc">antlr3SetTokenAPI()</a>, <a class="el" href="antlr3lexer_8c.html#af9d72282d839ad84befc641f4ca94330">emit()</a>, and <a class="el" href="antlr3commontoken_8c.html#a38b67f15c616153efe0f8010eb17fe91">setText8()</a>.</p>
</div>
</div>
<a class="anchor" id="a3ab0ac4c534deda43606fa1161f4452e"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TEXT_STRING" ref="a3ab0ac4c534deda43606fa1161f4452e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_TEXT_STRING   2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="antlr3commontreeadaptor_8c.html#a359e4d8f1cb4b8e5f3c37aefe005223f">createTokenFromToken()</a>, <a class="el" href="antlr3lexer_8c.html#af9d72282d839ad84befc641f4ca94330">emit()</a>, <a class="el" href="antlr3commontoken_8c.html#aec920b285c989ea0d7d4d926899cf767">getText()</a>, and <a class="el" href="antlr3commontoken_8c.html#a8cef72ba0eeff69a369502a4c211f6a6">setText()</a>.</p>
</div>
</div>
<a class="anchor" id="a9c3c0f56aca416d3c5b5334bb2f5857c"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TOKEN_DEFAULT_CHANNEL" ref="a9c3c0f56aca416d3c5b5334bb2f5857c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_TOKEN_DEFAULT_CHANNEL   0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default channel for a token. </p>
<p>Referenced by <a class="el" href="antlr3defs_8h.html#ad4ef5baa73e1fdd0f0c2fc4cce4277cb">antlr3CommonTokenStreamSourceNew()</a>, <a class="el" href="antlr3defs_8h.html#ad6214ed38e124f2ada5b7056c15b58dc">antlr3SetTokenAPI()</a>, <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga22c45f91acc78faa73e6b1fd637e3e0c">getMissingSymbol()</a>, <a class="el" href="antlr3lexer_8c.html#ad0765a37fb94635afbfaad254c12c496">nextTokenStr()</a>, <a class="el" href="antlr3lexer_8c.html#ada85822b7879271a8ce555c65a2274fa">reset()</a>, and <a class="el" href="antlr3commontoken_8c.html#ac98555d67ba2799ecbabc4a41d6d3258">toString()</a>.</p>
</div>
</div>
<a class="anchor" id="a603c0885903dbf262788c91f26101ae2"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TOKEN_DOWN" ref="a603c0885903dbf262788c91f26101ae2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_TOKEN_DOWN   2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Imaginary token type to cause a traversal of child nodes in a tree parser. </p>
<p>Referenced by <a class="el" href="antlr3commontreenodestream_8c.html#a7bc75a78609705ded62d1aad66f2cd12">addNavigationNode()</a>, <a class="el" href="antlr3defs_8h.html#af53a0945d04dc72b9a3b927c1fa5ffd7">antlr3CommonTreeNodeStreamNew()</a>, <a class="el" href="antlr3commontreenodestream_8c.html#ac4507475b023b7f2393c5fbe5d080469">fillBuffer()</a>, <a class="el" href="antlr3commontreenodestream_8c.html#a404d1d946e8d99139eb862d7c571e9dc">newDownNode()</a>, and <a class="el" href="antlr3commontreenodestream_8c.html#ab1d649516ec34b059ed33854308ca998">toStringWork()</a>.</p>
</div>
</div>
<a class="anchor" id="a1c8f8ac4a421a4adcad0c827fb4f91cd"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TOKEN_EOF" ref="a1c8f8ac4a421a4adcad0c827fb4f91cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_TOKEN_EOF   (ANTLR3_CHARSTREAM_EOF & 0xFFFFFFFF)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>End of file token. </p>
<p>Referenced by <a class="el" href="antlr3defs_8h.html#af53a0945d04dc72b9a3b927c1fa5ffd7">antlr3CommonTreeNodeStreamNew()</a>, <a class="el" href="antlr3defs_8h.html#a06b669c119c3421298972433404eff5a">antlr3dfapredict()</a>, <a class="el" href="antlr3defs_8h.html#aad5d94a0ad6c1d4788f95debb67cf642">antlr3LexerNew()</a>, <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#gab2d77cd376112c8ff6ed7353ba78dab7">antlr3RecognitionExceptionNew()</a>, <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#gafe29b544de6bf6a2f2f1cde76ffbcfef">consumeUntil()</a>, <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga8d35000d9ab1050dabe81cf7920934fe">consumeUntilSet()</a>, <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga3c88e896255781a0ace9fd1110900424">displayRecognitionError()</a>, <a class="el" href="antlr3tokenstream_8c.html#a6e9bf0e3483b4361c86ec64e495cc160">fillBuffer()</a>, <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga22c45f91acc78faa73e6b1fd637e3e0c">getMissingSymbol()</a>, <a class="el" href="antlr3commontoken_8c.html#aec920b285c989ea0d7d4d926899cf767">getText()</a>, and <a class="el" href="antlr3lexer_8c.html#ac9a1246efbb94ec9e0069b70c3c53502">nextToken()</a>.</p>
</div>
</div>
<a class="anchor" id="ae6add32e4a00e4a514491188b60196e0"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TOKEN_INVALID" ref="ae6add32e4a00e4a514491188b60196e0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_TOKEN_INVALID   0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicator of an invalid token. </p>
<p>Referenced by <a class="el" href="antlr3commontreenodestream_8c.html#add9884870fc81679730a126a0b0ab2d1">_LA()</a>, <a class="el" href="antlr3defs_8h.html#af53a0945d04dc72b9a3b927c1fa5ffd7">antlr3CommonTreeNodeStreamNew()</a>, <a class="el" href="antlr3defs_8h.html#aad5d94a0ad6c1d4788f95debb67cf642">antlr3LexerNew()</a>, <a class="el" href="antlr3defs_8h.html#ad6214ed38e124f2ada5b7056c15b58dc">antlr3SetTokenAPI()</a>, <a class="el" href="antlr3commontreeadaptor_8c.html#af5ce1e4012c15d828a8cb33f55049977">errorNode()</a>, <a class="el" href="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga833876e3010f505f0e12326360f6877d">recoverFromMismatchedSet()</a>, and <a class="el" href="antlr3lexer_8c.html#ada85822b7879271a8ce555c65a2274fa">reset()</a>.</p>
</div>
</div>
<a class="anchor" id="a0fe56e2df2fa8c65e2fba3a79b8af043"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TOKEN_UP" ref="a0fe56e2df2fa8c65e2fba3a79b8af043" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ANTLR3_TOKEN_UP   3</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Imaginary token type to signal the end of a stream of child nodes. </p>
<p>Referenced by <a class="el" href="antlr3defs_8h.html#af53a0945d04dc72b9a3b927c1fa5ffd7">antlr3CommonTreeNodeStreamNew()</a>, <a class="el" href="antlr3commontreenodestream_8c.html#ac4507475b023b7f2393c5fbe5d080469">fillBuffer()</a>, <a class="el" href="antlr3commontreenodestream_8c.html#aba2a1070fb666dd0aa01b84610ee41eb">newUpNode()</a>, and <a class="el" href="antlr3commontreenodestream_8c.html#ab1d649516ec34b059ed33854308ca998">toStringWork()</a>.</p>
</div>
</div>
<a class="anchor" id="ab42ef41116f8f2fe447484e2844cf0df"></a><!-- doxytag: member="antlr3commontoken.h::HIDDEN" ref="ab42ef41116f8f2fe447484e2844cf0df" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HIDDEN   99</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reserved channel number for a HIDDEN token - a token that is hidden from the parser. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ab35c5fc3921ac6bfa1dbb31681aa9a0f"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_COMMON_TOKEN" ref="ab35c5fc3921ac6bfa1dbb31681aa9a0f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n__struct.html">ANTLR3_COMMON_TOKEN_struct</a>
<a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n__struct.html">ANTLR3_COMMON_TOKEN</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The definition of an ANTLR3 common token structure, which all implementations of a token stream should provide, installing any further structures in the custom pointer element of this structure. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Token streams are in essence provided by lexers or other programs that serve as lexers. </dd></dl>
</div>
</div>
<a class="anchor" id="ae1962da0aae7400046a52818b5e7374d"></a><!-- doxytag: member="antlr3commontoken.h::ANTLR3_TOKEN_FACTORY" ref="ae1962da0aae7400046a52818b5e7374d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct_a_n_t_l_r3___t_o_k_e_n___f_a_c_t_o_r_y__struct.html">ANTLR3_TOKEN_FACTORY_struct</a>
<a class="el" href="struct_a_n_t_l_r3___t_o_k_e_n___f_a_c_t_o_r_y__struct.html">ANTLR3_TOKEN_FACTORY</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ANTLR3 Token factory interface to create lots of tokens efficiently rather than creating and freeing lots of little bits of memory. </p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="antlr3commontoken_8h.html">antlr3commontoken.h</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for ANTLR3C by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
