Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > f6ec3de51c94922f2240c0767594dcf5 > files > 3229

antlr3-C-docs-3.2-14.fc15.noarch.rpm

<!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: ANTLR3_COMMON_TOKEN_STREAM_struct Struct 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&#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</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('struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<h1>ANTLR3_COMMON_TOKEN_STREAM_struct Struct Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="ANTLR3_COMMON_TOKEN_STREAM_struct" -->
<p>Common token stream is an implementation of ANTLR_TOKEN_STREAM for the default parsers and recognizers.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;antlr3tokenstream.h&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ANTLR3_COMMON_TOKEN_STREAM_struct:</div>
<div class="dyncontent">
<div class="center"><img src="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct__coll__graph.png" border="0" usemap="#_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct_coll__map" alt="Collaboration graph"/></div>
<map name="_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct_coll__map" id="_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct_coll__map">
<area shape="rect" id="node2" href="struct_a_n_t_l_r3___t_o_k_e_n___s_t_r_e_a_m__struct.html" title="Definition of the ANTLR3 common token stream interface." alt="" coords="3640,269,3923,296"/><area shape="rect" id="node4" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n__struct.html" title="The definition of an ANTLR3 common token structure, which all implementations of a token stream shoul..." alt="" coords="1728,403,2011,429"/><area shape="rect" id="node27" href="struct_a_n_t_l_r3___t_o_k_e_n___s_o_u_r_c_e__struct.html" title="Definition of a token source, which has a pointer to a function that returns the next token (using a ..." alt="" coords="2165,211,2448,237"/><area shape="rect" id="node35" href="struct_a_n_t_l_r3___b_a_s_e___t_r_e_e___a_d_a_p_t_o_r__struct.html" title="ANTLR3_BASE_TREE_ADAPTOR_struct" alt="" coords="2625,455,2956,481"/><area shape="rect" id="node40" href="struct_a_n_t_l_r3___t_o_k_e_n___f_a_c_t_o_r_y__struct.html" title="ANTLR3 Token factory interface to create lots of tokens efficiently rather than creating and freeing ..." alt="" coords="2161,471,2452,497"/><area shape="rect" id="node6" href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html" title="Base string class tracks the allocations and provides simple string tracking functions." alt="" coords="441,315,663,341"/><area shape="rect" id="node9" href="struct_a_n_t_l_r3___s_t_r_i_n_g___f_a_c_t_o_r_y__struct.html" title="Definition of the string factory interface, which creates and tracks strings for you of various shape..." alt="" coords="844,449,1145,476"/><area shape="rect" id="node16" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html" title="Master context structure for an ANTLR3 C runtime based input stream." alt="" coords="1296,471,1579,497"/><area shape="rect" id="node19" href="struct_a_n_t_l_r3___i_n_t___s_t_r_e_a_m__struct.html" title="ANTLR3_INT_STREAM_struct" alt="" coords="864,184,1125,211"/><area shape="rect" id="node32" href="struct_a_n_t_l_r3___d_e_b_u_g___e_v_e_n_t___l_i_s_t_e_n_e_r__struct.html" title="The ANTLR3 debugging interface for communicating with ANLTR Works." alt="" coords="3147,383,3509,409"/><area shape="rect" id="node12" href="struct_a_n_t_l_r3___v_e_c_t_o_r__struct.html" title="ANTLR3_VECTOR_struct" alt="" coords="441,657,663,684"/><area shape="rect" id="node14" href="struct_a_n_t_l_r3___v_e_c_t_o_r___e_l_e_m_e_n_t__struct.html" title="ANTLR3_VECTOR_ELEMENT_struct" alt="" coords="7,657,308,684"/><area shape="rect" id="node45" href="struct_a_n_t_l_r3___l_i_s_t__struct.html" title="Structure that represents a LIST collection." alt="" coords="3680,827,3883,853"/><area shape="rect" id="node47" href="struct_a_n_t_l_r3___h_a_s_h___t_a_b_l_e__struct.html" title="Structure that tracks a hash table." alt="" coords="3197,827,3459,853"/><area shape="rect" id="node49" href="struct_a_n_t_l_r3___h_a_s_h___e_n_t_r_y__struct.html" title="Internal structure representing an element in a hash bucket." alt="" coords="2176,823,2437,849"/><area shape="rect" id="node54" href="struct_a_n_t_l_r3___h_a_s_h___b_u_c_k_e_t__struct.html" title="Internal structure of a hash table bucket, which tracks all keys that hash to the same bucket..." alt="" coords="2655,869,2927,896"/><area shape="rect" id="node52" href="struct_a_n_t_l_r3___h_a_s_h___k_e_y__struct.html" title="ANTLR3_HASH_KEY_struct" alt="" coords="1748,823,1991,849"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a>&#160;</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___s_t_r_e_a_m__struct.html#a0d9d2e70946a56bb76f6748d55c80372">channel</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>&#160;</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___s_t_r_e_a_m__struct.html#a6002a039b9758a44262ad424a1652a7b">channelOverrides</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Override map of tokens.  <a href="#a6002a039b9758a44262ad424a1652a7b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="antlr3defs_8h.html#a5b33dccbba3b7212539695e21df4079b">ANTLR3_BOOLEAN</a>&#160;</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___s_t_r_e_a_m__struct.html#acafcfb5efa9233c6f5b51a48b81d3eb2">discardOffChannel</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If this flag is set to ANTLR3_TRUE, then tokens that the stream sees that are not in the channel that this stream is tuned to, are not tracked in the tokens table.  <a href="#acafcfb5efa9233c6f5b51a48b81d3eb2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void(*&#160;</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___s_t_r_e_a_m__struct.html#aa851d1b2d1d1e28c84e988ac92972a30">discardOffChannelToks</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#a5b33dccbba3b7212539695e21df4079b">ANTLR3_BOOLEAN</a> discard)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal to discard off channel tokens from here on in.  <a href="#aa851d1b2d1d1e28c84e988ac92972a30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>&#160;</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___s_t_r_e_a_m__struct.html#a253949433cc0cae9544687a2f9e1facd">discardSet</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Discared set.  <a href="#a253949433cc0cae9544687a2f9e1facd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void(*&#160;</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___s_t_r_e_a_m__struct.html#a9342253f1da5c79b615324f77c523d70">discardTokenType</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#a6faef5c4687f8eb633d2aefea93973ca">ANTLR3_INT32</a> ttype)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a particular token type to the discard set.  <a href="#a9342253f1da5c79b615324f77c523d70"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void(*&#160;</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___s_t_r_e_a_m__struct.html#a062b7949ea434d5a82cf1a07a3f8c7ff">free</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function that knows how to free an ANTLR3_COMMON_TOKEN_STREAM.  <a href="#a062b7949ea434d5a82cf1a07a3f8c7ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>(*&#160;</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___s_t_r_e_a_m__struct.html#ab7edb18aa08d3a8826deca1cb976e31a">getTokenRange</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> start, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> stop)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function that returns all the tokens between a start and a stop index.  <a href="#ab7edb18aa08d3a8826deca1cb976e31a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___v_e_c_t_o_r__struct.html">pANTLR3_VECTOR</a>(*&#160;</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___s_t_r_e_a_m__struct.html#a1ac2d1d9b3b9d3bb80cac9f70c9d2df4">getTokens</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function that returns a pointer to the ANTLR3_LIST of all tokens in the stream (this causes the buffer to fill if we have not get any yet)  <a href="#a1ac2d1d9b3b9d3bb80cac9f70c9d2df4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>(*&#160;</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___s_t_r_e_a_m__struct.html#a6aab126893e96d0e0ca8c36450e908de">getTokensList</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> start, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> stop, <a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a> list)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function that returns all the tokens indicated by being a member of the supplied List.  <a href="#a6aab126893e96d0e0ca8c36450e908de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>(*&#160;</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___s_t_r_e_a_m__struct.html#ad9165a26655f08efe2ebd812e59779e1">getTokensSet</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> start, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> stop, <a class="el" href="struct_a_n_t_l_r3___b_i_t_s_e_t__struct.html">pANTLR3_BITSET</a> types)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function that returns all the tokens indicated by the specified bitset, within a range of tokens.  <a href="#ad9165a26655f08efe2ebd812e59779e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>(*&#160;</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___s_t_r_e_a_m__struct.html#a530543c21759c2e6f1fd0283a7d52671">getTokensType</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> start, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> stop, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> type)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function that returns all tokens of a certain type within a range.  <a href="#a530543c21759c2e6f1fd0283a7d52671"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="antlr3defs_8h.html#a6faef5c4687f8eb633d2aefea93973ca">ANTLR3_INT32</a>&#160;</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___s_t_r_e_a_m__struct.html#a03a16d2ed34642468b22aab98dabb1d1">p</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The index into the tokens list of the current token (the next one that will be consumed.  <a href="#a03a16d2ed34642468b22aab98dabb1d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void(*&#160;</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___s_t_r_e_a_m__struct.html#a542cb45a42cb59120d49630f42a3d030">setTokenTypeChannel</a> )(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> ttype, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a0d9d2e70946a56bb76f6748d55c80372">channel</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A simple filter mechanism whereby you can tell this token stream to force all tokens of type ttype to be on channel.  <a href="#a542cb45a42cb59120d49630f42a3d030"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&#160;</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___s_t_r_e_a_m__struct.html#ae313a96c7edf6e543f6c6c8cda1568cf">super</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Whatever is supplying the COMMON_TOKEN_STREAM needs a pointer to itself so that this can be accessed by any of the API functions which it implements.  <a href="#ae313a96c7edf6e543f6c6c8cda1568cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___v_e_c_t_o_r__struct.html">pANTLR3_VECTOR</a>&#160;</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___s_t_r_e_a_m__struct.html#ab1fb3f1cecceebdc61d838277670a7f0">tokens</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Records every single token pulled from the source indexed by the token index.  <a href="#ab1fb3f1cecceebdc61d838277670a7f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___t_o_k_e_n___s_t_r_e_a_m__struct.html">pANTLR3_TOKEN_STREAM</a>&#160;</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___s_t_r_e_a_m__struct.html#ad4ac4cf969cb48478aa44f7c708226e2">tstream</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The ANTLR3_TOKEN_STREAM interface implementation, which also includes the intstream implementation.  <a href="#ad4ac4cf969cb48478aa44f7c708226e2"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Common token stream is an implementation of ANTLR_TOKEN_STREAM for the default parsers and recognizers. </p>
<p>You may of course build your own implementation if you are so inclined. </p>
</div><hr/><h2>Field Documentation</h2>
<a class="anchor" id="a0d9d2e70946a56bb76f6748d55c80372"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::channel" ref="a0d9d2e70946a56bb76f6748d55c80372" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a0d9d2e70946a56bb76f6748d55c80372">ANTLR3_COMMON_TOKEN_STREAM_struct::channel</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ad4ef5baa73e1fdd0f0c2fc4cce4277cb">antlr3CommonTokenStreamSourceNew()</a>, <a class="el" href="antlr3tokenstream_8c.html#a6e9bf0e3483b4361c86ec64e495cc160">fillBuffer()</a>, <a class="el" href="antlr3tokenstream_8c.html#a1dd7cfaada47bc6206a16bacba7ca090">skipOffTokenChannels()</a>, and <a class="el" href="antlr3tokenstream_8c.html#a8cbe6600ea3b05f0f932a5e8c19ba0e5">skipOffTokenChannelsReverse()</a>.</p>

</div>
</div>
<a class="anchor" id="a6002a039b9758a44262ad424a1652a7b"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::channelOverrides" ref="a6002a039b9758a44262ad424a1652a7b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a6002a039b9758a44262ad424a1652a7b">ANTLR3_COMMON_TOKEN_STREAM_struct::channelOverrides</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Override map of tokens. </p>
<p>If a token type has an entry in here, then the pointer in the table points to an int, being the override channel number that should always be used for this token type. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ad4ef5baa73e1fdd0f0c2fc4cce4277cb">antlr3CommonTokenStreamSourceNew()</a>, <a class="el" href="antlr3tokenstream_8c.html#ab12eda11f60ee7a3ffc891d8d3880469">antlr3CTSFree()</a>, <a class="el" href="antlr3tokenstream_8c.html#a6e9bf0e3483b4361c86ec64e495cc160">fillBuffer()</a>, and <a class="el" href="antlr3tokenstream_8c.html#a9fb1191e855ea785830c468d4eaae493">setTokenTypeChannel()</a>.</p>

</div>
</div>
<a class="anchor" id="acafcfb5efa9233c6f5b51a48b81d3eb2"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::discardOffChannel" ref="acafcfb5efa9233c6f5b51a48b81d3eb2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="antlr3defs_8h.html#a5b33dccbba3b7212539695e21df4079b">ANTLR3_BOOLEAN</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#acafcfb5efa9233c6f5b51a48b81d3eb2">ANTLR3_COMMON_TOKEN_STREAM_struct::discardOffChannel</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>If this flag is set to ANTLR3_TRUE, then tokens that the stream sees that are not in the channel that this stream is tuned to, are not tracked in the tokens table. </p>
<p>When set to false, ALL tokens are added to the tracking. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ad4ef5baa73e1fdd0f0c2fc4cce4277cb">antlr3CommonTokenStreamSourceNew()</a>, <a class="el" href="antlr3tokenstream_8c.html#a1f684e577bbbd6c2caf93f928f66d3cb">discardOffChannel()</a>, and <a class="el" href="antlr3tokenstream_8c.html#a6e9bf0e3483b4361c86ec64e495cc160">fillBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="aa851d1b2d1d1e28c84e988ac92972a30"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::discardOffChannelToks" ref="aa851d1b2d1d1e28c84e988ac92972a30" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream, ANTLR3_BOOLEAN discard)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#aa851d1b2d1d1e28c84e988ac92972a30">ANTLR3_COMMON_TOKEN_STREAM_struct::discardOffChannelToks</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#a5b33dccbba3b7212539695e21df4079b">ANTLR3_BOOLEAN</a> discard)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Signal to discard off channel tokens from here on in. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>.</p>

</div>
</div>
<a class="anchor" id="a253949433cc0cae9544687a2f9e1facd"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::discardSet" ref="a253949433cc0cae9544687a2f9e1facd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a253949433cc0cae9544687a2f9e1facd">ANTLR3_COMMON_TOKEN_STREAM_struct::discardSet</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Discared set. </p>
<p>If a token has an entry in this table, then it is thrown away (data pointer is always NULL). </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ad4ef5baa73e1fdd0f0c2fc4cce4277cb">antlr3CommonTokenStreamSourceNew()</a>, <a class="el" href="antlr3tokenstream_8c.html#ab12eda11f60ee7a3ffc891d8d3880469">antlr3CTSFree()</a>, <a class="el" href="antlr3tokenstream_8c.html#a957ed00ca94b98506c14e2a2e93c76c2">discardTokenType()</a>, and <a class="el" href="antlr3tokenstream_8c.html#a6e9bf0e3483b4361c86ec64e495cc160">fillBuffer()</a>.</p>

</div>
</div>
<a class="anchor" id="a9342253f1da5c79b615324f77c523d70"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::discardTokenType" ref="a9342253f1da5c79b615324f77c523d70" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream, ANTLR3_INT32 ttype)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a9342253f1da5c79b615324f77c523d70">ANTLR3_COMMON_TOKEN_STREAM_struct::discardTokenType</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#a6faef5c4687f8eb633d2aefea93973ca">ANTLR3_INT32</a> ttype)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Add a particular token type to the discard set. </p>
<p>If a token is found to belong to this set, then it is skipped/thrown away </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>.</p>

</div>
</div>
<a class="anchor" id="a062b7949ea434d5a82cf1a07a3f8c7ff"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::free" ref="a062b7949ea434d5a82cf1a07a3f8c7ff" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a062b7949ea434d5a82cf1a07a3f8c7ff">ANTLR3_COMMON_TOKEN_STREAM_struct::free</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Function that knows how to free an ANTLR3_COMMON_TOKEN_STREAM. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ad4ef5baa73e1fdd0f0c2fc4cce4277cb">antlr3CommonTokenStreamSourceNew()</a>.</p>

</div>
</div>
<a class="anchor" id="ab7edb18aa08d3a8826deca1cb976e31a"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::getTokenRange" ref="ab7edb18aa08d3a8826deca1cb976e31a" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream, ANTLR3_UINT32 start, ANTLR3_UINT32 stop)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#ab7edb18aa08d3a8826deca1cb976e31a">ANTLR3_COMMON_TOKEN_STREAM_struct::getTokenRange</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> start, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> stop)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Function that returns all the tokens between a start and a stop index. </p>
<p>TODO: This is a new list (Ack! Maybe this is a reason to have factories for LISTS and HASHTABLES etc :-( come back to this) </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>.</p>

</div>
</div>
<a class="anchor" id="a1ac2d1d9b3b9d3bb80cac9f70c9d2df4"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::getTokens" ref="a1ac2d1d9b3b9d3bb80cac9f70c9d2df4" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___v_e_c_t_o_r__struct.html">pANTLR3_VECTOR</a>(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a1ac2d1d9b3b9d3bb80cac9f70c9d2df4">ANTLR3_COMMON_TOKEN_STREAM_struct::getTokens</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Function that returns a pointer to the ANTLR3_LIST of all tokens in the stream (this causes the buffer to fill if we have not get any yet) </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>.</p>

</div>
</div>
<a class="anchor" id="a6aab126893e96d0e0ca8c36450e908de"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::getTokensList" ref="a6aab126893e96d0e0ca8c36450e908de" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream, ANTLR3_UINT32 start, ANTLR3_UINT32 stop, pANTLR3_LIST list)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a6aab126893e96d0e0ca8c36450e908de">ANTLR3_COMMON_TOKEN_STREAM_struct::getTokensList</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> start, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> stop, <a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a> list)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Function that returns all the tokens indicated by being a member of the supplied List. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>.</p>

</div>
</div>
<a class="anchor" id="ad9165a26655f08efe2ebd812e59779e1"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::getTokensSet" ref="ad9165a26655f08efe2ebd812e59779e1" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream, ANTLR3_UINT32 start, ANTLR3_UINT32 stop, pANTLR3_BITSET types)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#ad9165a26655f08efe2ebd812e59779e1">ANTLR3_COMMON_TOKEN_STREAM_struct::getTokensSet</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> start, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> stop, <a class="el" href="struct_a_n_t_l_r3___b_i_t_s_e_t__struct.html">pANTLR3_BITSET</a> types)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Function that returns all the tokens indicated by the specified bitset, within a range of tokens. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>, <a class="el" href="antlr3tokenstream_8c.html#ab792e5bceb8b4ab761c0e1750b8ab0c0">getTokenRange()</a>, <a class="el" href="antlr3tokenstream_8c.html#ae2ed59b6cc8b4e577a8387440be6f844">getTokensList()</a>, and <a class="el" href="antlr3tokenstream_8c.html#a5ebafca6b5346f8aa57b25ac6f4f1238">getTokensType()</a>.</p>

</div>
</div>
<a class="anchor" id="a530543c21759c2e6f1fd0283a7d52671"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::getTokensType" ref="a530543c21759c2e6f1fd0283a7d52671" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream, ANTLR3_UINT32 start, ANTLR3_UINT32 stop, ANTLR3_UINT32 type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___l_i_s_t__struct.html">pANTLR3_LIST</a>(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a530543c21759c2e6f1fd0283a7d52671">ANTLR3_COMMON_TOKEN_STREAM_struct::getTokensType</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> start, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> stop, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> type)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Function that returns all tokens of a certain type within a range. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>.</p>

</div>
</div>
<a class="anchor" id="a03a16d2ed34642468b22aab98dabb1d1"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::p" ref="a03a16d2ed34642468b22aab98dabb1d1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="antlr3defs_8h.html#a6faef5c4687f8eb633d2aefea93973ca">ANTLR3_INT32</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a03a16d2ed34642468b22aab98dabb1d1">ANTLR3_COMMON_TOKEN_STREAM_struct::p</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The index into the tokens list of the current token (the next one that will be consumed. </p>
<p>p = -1 indicates that the token list is empty. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>, <a class="el" href="antlr3tokenstream_8c.html#a758c7f9e34d4c5cc9af1a797c945e2e5">consume()</a>, <a class="el" href="antlr3tokenstream_8c.html#a6e9bf0e3483b4361c86ec64e495cc160">fillBuffer()</a>, <a class="el" href="antlr3tokenstream_8c.html#ac468a91e063020d1ae77cfaa45ed0849">getTokens()</a>, <a class="el" href="antlr3tokenstream_8c.html#ae15f03d21ef4c155daf9592cb6b7751a">getTokensSet()</a>, <a class="el" href="antlr3tokenstream_8c.html#ac8379adc13ac8fbd685f1a2eb6bd0f02">LB()</a>, <a class="el" href="antlr3tokenstream_8c.html#ab83c14bd6b800935fa2459f48e500d22">seek()</a>, <a class="el" href="antlr3tokenstream_8c.html#a3e61cdd923ffb6550b1389eb8329cc4c">tindex()</a>, <a class="el" href="antlr3tokenstream_8c.html#a797f427bfdba8fc5bf09dd4aa2e2d30a">tokLT()</a>, <a class="el" href="antlr3tokenstream_8c.html#a8e379e6aaeac8fc2beab5e981986540f">toString()</a>, and <a class="el" href="antlr3tokenstream_8c.html#aa92e164be569dcd030d5f2248b002d72">toStringSS()</a>.</p>

</div>
</div>
<a class="anchor" id="a542cb45a42cb59120d49630f42a3d030"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::setTokenTypeChannel" ref="a542cb45a42cb59120d49630f42a3d030" args=")(struct ANTLR3_COMMON_TOKEN_STREAM_struct *tokenStream, ANTLR3_UINT32 ttype, ANTLR3_UINT32 channel)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a542cb45a42cb59120d49630f42a3d030">ANTLR3_COMMON_TOKEN_STREAM_struct::setTokenTypeChannel</a>)(struct <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> *tokenStream, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> ttype, <a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#a0d9d2e70946a56bb76f6748d55c80372">channel</a>)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A simple filter mechanism whereby you can tell this token stream to force all tokens of type ttype to be on channel. </p>
<p>For example, when interpreting, we cannot exec actions so we need to tell the stream to force all WS and NEWLINE to be a different, ignored channel. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>.</p>

</div>
</div>
<a class="anchor" id="ae313a96c7edf6e543f6c6c8cda1568cf"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::super" ref="ae313a96c7edf6e543f6c6c8cda1568cf" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#ae313a96c7edf6e543f6c6c8cda1568cf">ANTLR3_COMMON_TOKEN_STREAM_struct::super</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Whatever is supplying the COMMON_TOKEN_STREAM needs a pointer to itself so that this can be accessed by any of the API functions which it implements. </p>

</div>
</div>
<a class="anchor" id="ab1fb3f1cecceebdc61d838277670a7f0"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::tokens" ref="ab1fb3f1cecceebdc61d838277670a7f0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___v_e_c_t_o_r__struct.html">pANTLR3_VECTOR</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#ab1fb3f1cecceebdc61d838277670a7f0">ANTLR3_COMMON_TOKEN_STREAM_struct::tokens</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Records every single token pulled from the source indexed by the token index. </p>
<p>There might be more efficient ways to do this, such as referencing directly in to the token factory pools, but for now this is convenient and the ANTLR3_LIST is not a huge overhead as it only stores pointers anyway, but allows for iterations and so on. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>, <a class="el" href="antlr3tokenstream_8c.html#ab12eda11f60ee7a3ffc891d8d3880469">antlr3CTSFree()</a>, <a class="el" href="antlr3tokenstream_8c.html#a758c7f9e34d4c5cc9af1a797c945e2e5">consume()</a>, <a class="el" href="antlr3tokenstream_8c.html#a6e9bf0e3483b4361c86ec64e495cc160">fillBuffer()</a>, <a class="el" href="antlr3tokenstream_8c.html#a1cc599e37fb41f6b2077f18279545475">get()</a>, <a class="el" href="antlr3tokenstream_8c.html#ac468a91e063020d1ae77cfaa45ed0849">getTokens()</a>, <a class="el" href="antlr3tokenstream_8c.html#ac8379adc13ac8fbd685f1a2eb6bd0f02">LB()</a>, <a class="el" href="antlr3tokenstream_8c.html#a7d68f5af32504d0af4c13a4c9d33726d">size()</a>, <a class="el" href="antlr3tokenstream_8c.html#a1dd7cfaada47bc6206a16bacba7ca090">skipOffTokenChannels()</a>, <a class="el" href="antlr3tokenstream_8c.html#a8cbe6600ea3b05f0f932a5e8c19ba0e5">skipOffTokenChannelsReverse()</a>, <a class="el" href="antlr3tokenstream_8c.html#a797f427bfdba8fc5bf09dd4aa2e2d30a">tokLT()</a>, and <a class="el" href="antlr3tokenstream_8c.html#aa92e164be569dcd030d5f2248b002d72">toStringSS()</a>.</p>

</div>
</div>
<a class="anchor" id="ad4ac4cf969cb48478aa44f7c708226e2"></a><!-- doxytag: member="ANTLR3_COMMON_TOKEN_STREAM_struct::tstream" ref="ad4ac4cf969cb48478aa44f7c708226e2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_a_n_t_l_r3___t_o_k_e_n___s_t_r_e_a_m__struct.html">pANTLR3_TOKEN_STREAM</a> <a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html#ad4ac4cf969cb48478aa44f7c708226e2">ANTLR3_COMMON_TOKEN_STREAM_struct::tstream</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The ANTLR3_TOKEN_STREAM interface implementation, which also includes the intstream implementation. </p>
<p>We could duplicate the pANTLR_INT_STREAM in this interface and initialize it to a copy, but this could be confusing it just results in one more level of indirection and I think that with judicial use of 'const' later, the optimizer will do decent job. </p>

<p>Referenced by <a class="el" href="antlr3defs_8h.html#ada21cf0d75ef83806a60990556d86fe0">antlr3CommonTokenDebugStreamSourceNew()</a>, <a class="el" href="antlr3defs_8h.html#ab8426bed8df754240d19d2ee37edee70">antlr3CommonTokenStreamNew()</a>, <a class="el" href="antlr3defs_8h.html#ad4ef5baa73e1fdd0f0c2fc4cce4277cb">antlr3CommonTokenStreamSourceNew()</a>, <a class="el" href="antlr3tokenstream_8c.html#ab12eda11f60ee7a3ffc891d8d3880469">antlr3CTSFree()</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="antlr3tokenstream_8c.html#a6e9bf0e3483b4361c86ec64e495cc160">fillBuffer()</a>, <a class="el" href="antlr3tokenstream_8c.html#ae15f03d21ef4c155daf9592cb6b7751a">getTokensSet()</a>, and <a class="el" href="antlr3tokenstream_8c.html#a1dd7cfaada47bc6206a16bacba7ca090">skipOffTokenChannels()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="antlr3tokenstream_8h.html">antlr3tokenstream.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="struct_a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a>      </li>
      <li class="footer">Generated on Tue Feb 8 2011 for ANTLR3C by&#160;
<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>