<!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_BASE_RECOGNIZER - Base Recognizer Class Definition</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><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</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('group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.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>ANTLR3_BASE_RECOGNIZER - Base Recognizer Class Definition</h1> </div> <div class="ingroups"><a class="el" href="group__apistructures.html">API Typedefs and Structs</a></div></div> <div class="contents"> <p>This is the definition of the base recognizer interface, instantiations of which are referred to via <a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga5aeeb8dcbf65f45605ae07cbd618e24c" title="Pointer to an instantiation of the 'class' ANTLR3_BASE_RECOGNIZER.">pANTLR3_BASE_RECOGNIZER</a>. <a href="#_details">More...</a></p> <div class="dynheader"> Collaboration diagram for ANTLR3_BASE_RECOGNIZER - Base Recognizer Class Definition:</div> <div class="dyncontent"> <center><table><tr><td><img src="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.png" border="0" alt="" usemap="#group______a__n__t__l__r3______b__a__s__e______r__e__c__o__g__n__i__z__e__r"/> <map name="group______a__n__t__l__r3______b__a__s__e______r__e__c__o__g__n__i__z__e__r" id="group______a__n__t__l__r3______b__a__s__e______r__e__c__o__g__n__i__z__e__r"> <area shape="rect" id="node1" href="group__apistructures.html" title="These structures (and the typedefs that you use to reference them and their pointers) are the C equiv..." alt="" coords="7,5,268,32"/></map> </td></tr></table></center> </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___b_a_s_e___r_e_c_o_g_n_i_z_e_r__struct.html">ANTLR3_BASE_RECOGNIZER_struct</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Base tracking context structure for all types of recognizers. <a href="struct_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r__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="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga63faeec6cee4f885c4b90a6d0cc2f5b4">ANTLR3_TYPE_LEXER</a>   0x0001</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Type indicator for a lexer recognizer. <a href="#ga63faeec6cee4f885c4b90a6d0cc2f5b4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#gafee8a3d7d292291a4cb15619c6bca466">ANTLR3_TYPE_PARSER</a>   0x0002</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Type indicator for a parser recognizer. <a href="#gafee8a3d7d292291a4cb15619c6bca466"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga3ff933756e4fc6d8fd9a5a8a0d67bb98">ANTLR3_TYPE_TREE_PARSER</a>   0x0004</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Type indicator for a tree parser recognizer. <a href="#ga3ff933756e4fc6d8fd9a5a8a0d67bb98"></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___b_a_s_e___r_e_c_o_g_n_i_z_e_r__struct.html">ANTLR3_BASE_RECOGNIZER_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#gac1374f941ff00f5709ca1e682d9f8e43">ANTLR3_BASE_RECOGNIZER</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Base tracking context structure for all types of recognizers. <a href="#gac1374f941ff00f5709ca1e682d9f8e43"></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___b_a_s_e___r_e_c_o_g_n_i_z_e_r__struct.html">ANTLR3_BASE_RECOGNIZER_struct</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga5aeeb8dcbf65f45605ae07cbd618e24c">pANTLR3_BASE_RECOGNIZER</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to an instantiation of the 'class' <a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#gac1374f941ff00f5709ca1e682d9f8e43" title="Base tracking context structure for all types of recognizers.">ANTLR3_BASE_RECOGNIZER</a>. <a href="#ga5aeeb8dcbf65f45605ae07cbd618e24c"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This is the definition of the base recognizer interface, instantiations of which are referred to via <a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga5aeeb8dcbf65f45605ae07cbd618e24c" title="Pointer to an instantiation of the 'class' ANTLR3_BASE_RECOGNIZER.">pANTLR3_BASE_RECOGNIZER</a>. </p> <p>In general you will not refer to one of these structures directly as a a <a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga5aeeb8dcbf65f45605ae07cbd618e24c" title="Pointer to an instantiation of the 'class' ANTLR3_BASE_RECOGNIZER.">pANTLR3_BASE_RECOGNIZER</a> will be embedded within a higher level object such as <a class="el" href="group___a_n_t_l_r3___p_a_r_s_e_r.html#gaa68a53fd6b2d899a8136c64e08fc1dbd" title="Pointer to an instantiation of 'class' ANTLR3_PARSER.">pANTLR3_PARSER</a> </p> <hr/><h2>Define Documentation</h2> <a class="anchor" id="ga63faeec6cee4f885c4b90a6d0cc2f5b4"></a><!-- doxytag: member="antlr3baserecognizer.h::ANTLR3_TYPE_LEXER" ref="ga63faeec6cee4f885c4b90a6d0cc2f5b4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ANTLR3_TYPE_LEXER   0x0001</td> </tr> </table> </div> <div class="memdoc"> <p>Type indicator for a lexer recognizer. </p> <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#gaecb4f403651c25610bcceff641027d02">alreadyParsedRule()</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>, 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#ga0b61381c64a3cf6fa719be2f3fe6cc79">memoize()</a>.</p> </div> </div> <a class="anchor" id="gafee8a3d7d292291a4cb15619c6bca466"></a><!-- doxytag: member="antlr3baserecognizer.h::ANTLR3_TYPE_PARSER" ref="gafee8a3d7d292291a4cb15619c6bca466" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ANTLR3_TYPE_PARSER   0x0002</td> </tr> </table> </div> <div class="memdoc"> <p>Type indicator for a parser recognizer. </p> <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#gaecb4f403651c25610bcceff641027d02">alreadyParsedRule()</a>, <a class="el" href="antlr3defs_8h.html#ae667dafdcef9adc2fceebc8420a7cded">antlr3ParserNew()</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="antlr3defs_8h.html#a8a8b2581755eff523fb3d2e427bb9b3f">antlr3TreeParserNewStream()</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="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga06172ef38079026fc3d29bea9a046cc3">match()</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#gac6666b109c5d2fb42e311b0a248e0bb0">matchAny()</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#ga0b61381c64a3cf6fa719be2f3fe6cc79">memoize()</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#gaf8c302d1762b73b1a80c88ca71210472">mismatch()</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#ga911941c0a78751dd6eae32d1fd3f3a2d">recover()</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#ga733153563bd70d3b65fce9bd665fb61f">recoverFromMismatchedElement()</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>, <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#ga4876d181d8cca1dcee4ebc7b0d313b28">recoverFromMismatchedToken()</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#gaab17b157e62f1564570c784ec4b184c5">synpred()</a>.</p> </div> </div> <a class="anchor" id="ga3ff933756e4fc6d8fd9a5a8a0d67bb98"></a><!-- doxytag: member="antlr3baserecognizer.h::ANTLR3_TYPE_TREE_PARSER" ref="ga3ff933756e4fc6d8fd9a5a8a0d67bb98" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ANTLR3_TYPE_TREE_PARSER   0x0004</td> </tr> </table> </div> <div class="memdoc"> <p>Type indicator for a tree parser recognizer. </p> <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#gaecb4f403651c25610bcceff641027d02">alreadyParsedRule()</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="antlr3defs_8h.html#a8a8b2581755eff523fb3d2e427bb9b3f">antlr3TreeParserNewStream()</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="group__p_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#ga06172ef38079026fc3d29bea9a046cc3">match()</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#gac6666b109c5d2fb42e311b0a248e0bb0">matchAny()</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#ga0b61381c64a3cf6fa719be2f3fe6cc79">memoize()</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#ga911941c0a78751dd6eae32d1fd3f3a2d">recover()</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#ga733153563bd70d3b65fce9bd665fb61f">recoverFromMismatchedElement()</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>, <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#ga4876d181d8cca1dcee4ebc7b0d313b28">recoverFromMismatchedToken()</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#gaab17b157e62f1564570c784ec4b184c5">synpred()</a>.</p> </div> </div> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="gac1374f941ff00f5709ca1e682d9f8e43"></a><!-- doxytag: member="antlr3baserecognizer.h::ANTLR3_BASE_RECOGNIZER" ref="gac1374f941ff00f5709ca1e682d9f8e43" 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___b_a_s_e___r_e_c_o_g_n_i_z_e_r__struct.html">ANTLR3_BASE_RECOGNIZER_struct</a> <a class="el" href="struct_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r__struct.html">ANTLR3_BASE_RECOGNIZER</a></td> </tr> </table> </div> <div class="memdoc"> <p>Base tracking context structure for all types of recognizers. </p> </div> </div> <a class="anchor" id="ga5aeeb8dcbf65f45605ae07cbd618e24c"></a><!-- doxytag: member="antlr3interfaces.h::pANTLR3_BASE_RECOGNIZER" ref="ga5aeeb8dcbf65f45605ae07cbd618e24c" 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___b_a_s_e___r_e_c_o_g_n_i_z_e_r__struct.html">ANTLR3_BASE_RECOGNIZER_struct</a>* <a class="el" href="struct_a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r__struct.html">pANTLR3_BASE_RECOGNIZER</a></td> </tr> </table> </div> <div class="memdoc"> <p>Pointer to an instantiation of the 'class' <a class="el" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html#gac1374f941ff00f5709ca1e682d9f8e43" title="Base tracking context structure for all types of recognizers.">ANTLR3_BASE_RECOGNIZER</a>. </p> </div> </div> </div> </div> <div id="nav-path" class="navpath"> <ul> <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>