<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ANTLR3C: include/antlr3tokenstream.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ANTLR3C  <span id="projectnumber">3.3.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('antlr3tokenstream_8h.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#typedef-members">Typedefs</a> </div> <div class="headertitle"> <div class="title">antlr3tokenstream.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>Defines the interface for an ANTLR3 common token stream. <a href="#details">More...</a></p> <div class="textblock"><code>#include <<a class="el" href="antlr3defs_8h.html">antlr3defs.h</a>></code><br /> <code>#include <<a class="el" href="antlr3string_8h.html">antlr3string.h</a>></code><br /> <code>#include <<a class="el" href="antlr3collections_8h.html">antlr3collections.h</a>></code><br /> <code>#include <<a class="el" href="antlr3input_8h.html">antlr3input.h</a>></code><br /> <code>#include <<a class="el" href="antlr3commontoken_8h.html">antlr3commontoken.h</a>></code><br /> <code>#include <<a class="el" href="antlr3bitset_8h.html">antlr3bitset.h</a>></code><br /> <code>#include <<a class="el" href="antlr3debugeventlistener_8h.html">antlr3debugeventlistener.h</a>></code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for antlr3tokenstream.h:</div> <div class="dyncontent"> <div class="center"><img src="antlr3tokenstream_8h__incl.png" border="0" usemap="#include_2antlr3tokenstream_8h" alt=""/></div> <map name="include_2antlr3tokenstream_8h" id="include_2antlr3tokenstream_8h"> <area shape="rect" title="Defines the interface for an ANTLR3 common token stream." alt="" coords="1142,5,1338,32"/> <area shape="rect" href="antlr3defs_8h.html" title="Basic type and constant definitions for ANTLR3 Runtime." alt="" coords="1166,453,1263,480"/> <area shape="rect" href="antlr3string_8h.html" title="Simple string interface allows indiscriminate allocation of strings such that they can be allocated a..." alt="" coords="1045,229,1152,256"/> <area shape="rect" href="antlr3collections_8h.html" title=" " alt="" coords="943,304,1079,331"/> <area shape="rect" href="antlr3bitset_8h.html" title="Defines the basic structures of an ANTLR3 bitset." alt="" coords="945,379,1050,405"/> <area shape="rect" href="antlr3input_8h.html" title="Defines the basic structures used to manipulate character streams from any input source." alt="" coords="1414,155,1517,181"/> <area shape="rect" href="antlr3commontoken_8h.html" title="Defines the interface for a common token." alt="" coords="1328,304,1488,331"/> <area shape="rect" href="antlr3debugeventlistener_8h.html" title="The definition of all debugging events that a recognizer can trigger." alt="" coords="1147,80,1333,107"/> <area shape="rect" href="antlr3errors_8h.html" title=" " alt="" coords="2167,528,2273,555"/> <area shape="rect" title=" " alt="" coords="5,528,115,555"/> <area shape="rect" title=" " alt="" coords="139,528,203,555"/> <area shape="rect" title=" " alt="" coords="227,528,296,555"/> <area shape="rect" title=" " alt="" coords="321,528,410,555"/> <area shape="rect" title=" " alt="" coords="435,528,515,555"/> <area shape="rect" title=" " alt="" coords="539,528,607,555"/> <area shape="rect" title=" " alt="" coords="631,528,705,555"/> <area shape="rect" title=" " alt="" coords="729,528,802,555"/> <area shape="rect" title=" " alt="" coords="827,528,896,555"/> <area shape="rect" title=" " alt="" coords="920,528,995,555"/> <area shape="rect" title=" " alt="" coords="1019,528,1101,555"/> <area shape="rect" title=" " alt="" coords="1126,528,1197,555"/> <area shape="rect" title=" " alt="" coords="1221,528,1315,555"/> <area shape="rect" title=" " alt="" coords="1339,528,1435,555"/> <area shape="rect" title=" " alt="" coords="1459,528,1560,555"/> <area shape="rect" title=" " alt="" coords="1585,528,1703,555"/> <area shape="rect" title=" " alt="" coords="1727,528,1798,555"/> <area shape="rect" title=" " alt="" coords="1823,528,1897,555"/> <area shape="rect" title=" " alt="" coords="1921,528,1988,555"/> <area shape="rect" href="antlr3interfaces_8h.html" title="Declarations for all the antlr3 C runtime interfaces/classes." alt="" coords="2012,528,2143,555"/> <area shape="rect" href="antlr3convertutf_8h.html" title=" " alt="" coords="2297,528,2431,555"/> <area shape="rect" href="antlr3intstream_8h.html" title="Defines the the class interface for an antlr3 INTSTREAM." alt="" coords="1329,229,1458,256"/> <area shape="rect" href="antlr3basetree_8h.html" title="Definition of the ANTLR3 base tree." alt="" coords="1080,155,1203,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="antlr3tokenstream_8h__dep__incl.png" border="0" usemap="#include_2antlr3tokenstream_8hdep" alt=""/></div> <map name="include_2antlr3tokenstream_8hdep" id="include_2antlr3tokenstream_8hdep"> <area shape="rect" title="Defines the interface for an ANTLR3 common token stream." alt="" coords="153,5,349,32"/> <area shape="rect" href="antlr3tokenstream_8c.html" title="Default implementation of CommonTokenStream." alt="" coords="5,80,173,107"/> <area shape="rect" href="antlr3_8h.html" title=" " alt="" coords="569,229,687,256"/> <area shape="rect" href="antlr3baserecognizer_8h.html" title="Defines the basic structure to support recognizing by either a lexer, parser, or tree parser." alt="" coords="640,80,851,107"/> <area shape="rect" href="antlr3lexer_8h.html" title="Base interface for any ANTLR3 lexer." alt="" coords="249,155,397,181"/> <area shape="rect" href="antlr3collections_8c.html" title="Provides a number of useful functions that are roughly equivalent to java HashTable and List for the ..." alt="" coords="153,304,309,331"/> <area shape="rect" href="antlr3commontoken_8c.html" title=" " alt="" coords="333,304,513,331"/> <area shape="rect" href="antlr3debughandlers_8c.html" title="Provides the debugging functions invoked by a recognizer built using the debug generator mode of the ..." alt="" coords="537,304,719,331"/> <area shape="rect" href="antlr3encodings_8c.html" title=" " alt="" coords="743,304,897,331"/> <area shape="rect" href="antlr3filestream_8c.html" title="The ANTLR3 C filestream is used when the source character stream is a filesystem based input set and ..." alt="" coords="921,304,1073,331"/> <area shape="rect" href="antlr3baserecognizer_8c.html" title="Contains the base functions that all recognizers require." alt="" coords="1289,155,1471,181"/> <area shape="rect" href="antlr3cyclicdfa_8h.html" title=" " alt="" coords="421,155,592,181"/> <area shape="rect" href="antlr3parser_8h.html" title="Base implementation of an ANTLR3 parser." alt="" coords="667,155,824,181"/> <area shape="rect" href="antlr3rewritestreams_8h.html" title=" " alt="" coords="849,155,1058,181"/> <area shape="rect" href="antlr3treeparser_8h.html" title=" " alt="" coords="1083,155,1264,181"/> <area shape="rect" href="antlr3cyclicdfa_8c.html" title=" " alt="" coords="402,229,545,256"/> <area shape="rect" href="antlr3lexer_8c.html" title="Base implementation of an antlr 3 lexer." alt="" coords="257,229,377,256"/> <area shape="rect" href="antlr3parser_8c.html" title="Implementation of the base functionality for an ANTLR3 parser." alt="" coords="711,229,841,256"/> <area shape="rect" href="antlr3rewritestreams_8c.html" title="Implementation of token/tree streams that are used by the tree re-write rules to manipulate the token..." alt="" coords="865,229,1047,256"/> <area shape="rect" href="antlr3treeparser_8c.html" title="Implementation of the tree parser and overrides for the base recognizer." alt="" coords="1097,229,1250,256"/> </map> </div> </div><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><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___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Common token stream is an implementation of ANTLR_TOKEN_STREAM for the default parsers and recognizers. <a 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#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><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___s_o_u_r_c_e__struct.html">ANTLR3_TOKEN_SOURCE_struct</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Definition of a token source, which has a pointer to a function that returns the next token (using a token factory if it is going to be efficient) and a pointer to an ANTLR3_INPUT_STREAM. <a href="struct_a_n_t_l_r3___t_o_k_e_n___s_o_u_r_c_e__struct.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><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___s_t_r_e_a_m__struct.html">ANTLR3_TOKEN_STREAM_struct</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Definition of the ANTLR3 common token stream interface. <a href="struct_a_n_t_l_r3___t_o_k_e_n___s_t_r_e_a_m__struct.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a463cd94e4fdea8a00a303e6868047faa"><td class="memItemLeft" align="right" valign="top">typedef 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> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3tokenstream_8h.html#a463cd94e4fdea8a00a303e6868047faa">ANTLR3_COMMON_TOKEN_STREAM</a></td></tr> <tr class="memdesc:a463cd94e4fdea8a00a303e6868047faa"><td class="mdescLeft"> </td><td class="mdescRight">Common token stream is an implementation of ANTLR_TOKEN_STREAM for the default parsers and recognizers. <a href="#a463cd94e4fdea8a00a303e6868047faa">More...</a><br /></td></tr> <tr class="separator:a463cd94e4fdea8a00a303e6868047faa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7c8ee4917886d2c4e04a5c0346ef69c9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_a_n_t_l_r3___t_o_k_e_n___s_o_u_r_c_e__struct.html">ANTLR3_TOKEN_SOURCE_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3tokenstream_8h.html#a7c8ee4917886d2c4e04a5c0346ef69c9">ANTLR3_TOKEN_SOURCE</a></td></tr> <tr class="memdesc:a7c8ee4917886d2c4e04a5c0346ef69c9"><td class="mdescLeft"> </td><td class="mdescRight">Definition of a token source, which has a pointer to a function that returns the next token (using a token factory if it is going to be efficient) and a pointer to an ANTLR3_INPUT_STREAM. <a href="#a7c8ee4917886d2c4e04a5c0346ef69c9">More...</a><br /></td></tr> <tr class="separator:a7c8ee4917886d2c4e04a5c0346ef69c9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1b5980b8a378f07bca473db62232025c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_a_n_t_l_r3___t_o_k_e_n___s_t_r_e_a_m__struct.html">ANTLR3_TOKEN_STREAM_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3tokenstream_8h.html#a1b5980b8a378f07bca473db62232025c">ANTLR3_TOKEN_STREAM</a></td></tr> <tr class="memdesc:a1b5980b8a378f07bca473db62232025c"><td class="mdescLeft"> </td><td class="mdescRight">Definition of the ANTLR3 common token stream interface. <a href="#a1b5980b8a378f07bca473db62232025c">More...</a><br /></td></tr> <tr class="separator:a1b5980b8a378f07bca473db62232025c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Defines the interface for an ANTLR3 common token stream. </p> <p>Custom token streams should create one of these and then override any functions by installing their own pointers to implement the various functions. </p> </div><h2 class="groupheader">Typedef Documentation</h2> <a id="a463cd94e4fdea8a00a303e6868047faa"></a> <h2 class="memtitle"><span class="permalink"><a href="#a463cd94e4fdea8a00a303e6868047faa">◆ </a></span>ANTLR3_COMMON_TOKEN_STREAM</h2> <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___s_t_r_e_a_m__struct.html">ANTLR3_COMMON_TOKEN_STREAM_struct</a> <a class="el" href="antlr3tokenstream_8h.html#a463cd94e4fdea8a00a303e6868047faa">ANTLR3_COMMON_TOKEN_STREAM</a></td> </tr> </table> </div><div class="memdoc"> <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> </div> <a id="a7c8ee4917886d2c4e04a5c0346ef69c9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7c8ee4917886d2c4e04a5c0346ef69c9">◆ </a></span>ANTLR3_TOKEN_SOURCE</h2> <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___s_o_u_r_c_e__struct.html">ANTLR3_TOKEN_SOURCE_struct</a> <a class="el" href="antlr3tokenstream_8h.html#a7c8ee4917886d2c4e04a5c0346ef69c9">ANTLR3_TOKEN_SOURCE</a></td> </tr> </table> </div><div class="memdoc"> <p>Definition of a token source, which has a pointer to a function that returns the next token (using a token factory if it is going to be efficient) and a pointer to an ANTLR3_INPUT_STREAM. </p> <p>This is slightly different to the Java interface because we have no way to implement multiple interfaces without defining them in the interface structure or casting (void *), which is too convoluted. </p> </div> </div> <a id="a1b5980b8a378f07bca473db62232025c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1b5980b8a378f07bca473db62232025c">◆ </a></span>ANTLR3_TOKEN_STREAM</h2> <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___s_t_r_e_a_m__struct.html">ANTLR3_TOKEN_STREAM_struct</a> <a class="el" href="antlr3tokenstream_8h.html#a1b5980b8a378f07bca473db62232025c">ANTLR3_TOKEN_STREAM</a></td> </tr> </table> </div><div class="memdoc"> <p>Definition of the ANTLR3 common token stream interface. </p> <dl class="section remark"><dt>Remarks</dt><dd>Much of the documentation for this interface is stolen from Ter's Java implementation. </dd></dl> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="antlr3tokenstream_8h.html">antlr3tokenstream.h</a></li> <li class="footer">Generated on Fri May 3 2019 05:59:10 for ANTLR3C by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> </ul> </div> </body> </html>