<!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: API Typedefs and Structs</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__apistructures.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#groups">Modules</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<h1>API Typedefs and Structs</h1> </div>
<div class="ingroups"><a class="el" href="group__apiclasses.html">API Classes</a></div></div>
<div class="contents">
<p>These structures (and the typedefs that you use to reference them and their pointers) are the C equivalent of objects.
<a href="#_details">More...</a></p>
<div class="dynheader">
Collaboration diagram for API Typedefs and Structs:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__apistructures.png" border="0" alt="" usemap="#group____apistructures"/>
<map name="group____apistructures" id="group____apistructures">
<area shape="rect" id="node1" href="group___a_n_t_l_r3___t_r_e_e___p_a_r_s_e_r.html" title="ANTLR3_TREE_PARSER - Tree Parser Class Definition" alt="" coords="624,25,1136,51"/><area shape="rect" id="node2" href="group___a_n_t_l_r3___b_a_s_e___t_r_e_e.html" title="ANTLR3_BASE_TREE - Base Tree Class Definition" alt="" coords="644,75,1116,102"/><area shape="rect" id="node3" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_r_e_e.html" title="ANTLR3_COMMON_TREE - Common Tree Class Definition" alt="" coords="624,126,1136,153"/><area shape="rect" id="node5" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m.html" title="ANTLR3_COMMON_TOKEN_STREAM - Common Token Stream Class Definition" alt="" coords="544,177,1216,203"/><area shape="rect" id="node6" href="group___a_n_t_l_r3___a_r_b_o_r_e_t_u_m.html" title="ANTLR3_ARBORETUM - Tree Factory Class Definition" alt="" coords="629,227,1131,254"/><area shape="rect" id="node7" href="group___a_n_t_l_r3___l_e_x_e_r.html" title="ANTLR3_LEXER - Lexer Class Definition" alt="" coords="684,278,1076,305"/><area shape="rect" id="node8" href="group___a_n_t_l_r3___v_e_c_t_o_r.html" title="ANTLR3_VECTOR - Vector Class Definition" alt="" coords="675,329,1085,355"/><area shape="rect" id="node9" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_r_e_e___n_o_d_e___s_t_r_e_a_m.html" title="ANTLR3_COMMON_TREE_NODE_STREAM - Common Tree Node Class Definition" alt="" coords="539,379,1221,406"/><area shape="rect" id="node10" href="group___a_n_t_l_r3___s_t_a_c_k.html" title="ANTLR3_STACK - Stack Class Definition" alt="" coords="684,430,1076,457"/><area shape="rect" id="node12" href="group___a_n_t_l_r3___e_x_c_e_p_t_i_o_n.html" title="ANTLR3_EXCEPTION - Exception Class Definition" alt="" coords="644,481,1116,507"/><area shape="rect" id="node13" href="group___a_n_t_l_r3___b_a_s_e___t_r_e_e___a_d_a_p_t_o_r.html" title="ANTLR3_BASE_TREE_ADAPTOR - Base Tree Class Definition" alt="" coords="604,531,1156,558"/><area shape="rect" id="node14" href="group___a_n_t_l_r3___s_t_r_i_n_g.html" title="ANTLR3_STRING - String Class Definition" alt="" coords="675,582,1085,609"/><area shape="rect" id="node15" href="group___a_n_t_l_r3___r_e_c_o_g_n_i_z_e_r___s_h_a_r_e_d___s_t_a_t_e.html" title="ANTLR3_RECOGNIZER_SHARED_STATE Recognizer Shared State Class Definition" alt="" coords="515,633,1245,659"/><area shape="rect" id="node16" href="group___a_n_t_l_r3___l_i_s_t.html" title="ANTLR3_LIST - List Class Definition" alt="" coords="695,683,1065,710"/><area shape="rect" id="node17" href="group___a_n_t_l_r3___t_r_e_e___w_a_l_k___s_t_a_t_e.html" title="ANTLR3_TREE_WALK_STATE - Tree Walk State Class Definition" alt="" coords="584,734,1176,761"/><area shape="rect" id="node18" href="group___a_n_t_l_r3___t_o_k_e_n___s_o_u_r_c_e.html" title="ANTLR3_TOKEN_SOURCE - Token Source Class Definition" alt="" coords="615,785,1145,811"/><area shape="rect" id="node19" href="group___a_n_t_l_r3___s_t_r_i_n_g___f_a_c_t_o_r_y.html" title="ANTLR3_STRING_FACTORY - String Factory Class Definition" alt="" coords="595,835,1165,862"/><area shape="rect" id="node20" href="group___a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m.html" title="ANTLR3_INPUT_STREAM - Input Stream Class Definition" alt="" coords="615,886,1145,913"/><area shape="rect" id="node21" href="group___a_n_t_l_r3___l_e_x___s_t_a_t_e.html" title="ANTLR3_LEX_STATE - Lexer State Class Definition" alt="" coords="635,937,1125,963"/><area shape="rect" id="node22" href="group___a_n_t_l_r3___h_a_s_h___e_n_u_m.html" title="ANTLR3_HASH_ENUM - Hash Table Enumerator Class Definition" alt="" coords="584,987,1176,1014"/><area shape="rect" id="node23" href="group___a_n_t_l_r3___i_n_t___t_r_i_e.html" title="ANTLR3_INT_TRIE - Trie Class Definition" alt="" coords="675,1038,1085,1065"/><area shape="rect" id="node24" href="group___a_n_t_l_r3___t_o_k_e_n___f_a_c_t_o_r_y.html" title="ANTLR3_TOKEN_FACTORY - Token Factory Class Definition" alt="" coords="604,1089,1156,1115"/><area shape="rect" id="node25" href="group___a_n_t_l_r3___b_i_t_s_e_t.html" title="ANTLR3_BITSET - Bitset Class Definition" alt="" coords="675,1139,1085,1166"/><area shape="rect" id="node26" href="group___a_n_t_l_r3___h_a_s_h___t_a_b_l_e.html" title="ANTLR3_HASH_TABLE - Hash Table Class Definition" alt="" coords="635,1190,1125,1217"/><area shape="rect" id="node27" href="group___a_n_t_l_r3___b_a_s_e___r_e_c_o_g_n_i_z_e_r.html" title="This is the definition of the base recognizer interface, instantiations of which are referred to via ..." alt="" coords="584,1241,1176,1267"/><area shape="rect" id="node28" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n.html" title="ANTLR3_COMMON_TOKEN - Common Token Class Definition" alt="" coords="615,1291,1145,1318"/><area shape="rect" id="node29" href="group___a_n_t_l_r3___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m.html" title="ANTLR3_REWRITE_RULE_ELEMENT_STREAM - Token Rewrite Stream Class Definition" alt="" coords="499,1342,1261,1369"/><area shape="rect" id="node30" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_r_e_e___a_d_a_p_t_o_r.html" title="ANTLR3_COMMON_TREE_ADAPTOR - Common Tree Adaptor Class Definition" alt="" coords="544,1393,1216,1419"/><area shape="rect" id="node31" href="group___a_n_t_l_r3___t_o_k_e_n___s_t_r_e_a_m.html" title="ANTLR3_TOKEN_STREAM - Token Stream Class Definition" alt="" coords="615,1443,1145,1470"/><area shape="rect" id="node32" href="group___a_n_t_l_r3___d_e_b_u_g___e_v_e_n_t___l_i_s_t_e_n_e_r.html" title="ANTLR3_DEBUG_EVENT_LISTENER - Debugger Class Definition" alt="" coords="595,1494,1165,1521"/><area shape="rect" id="node33" href="group___a_n_t_l_r3___h_a_s_h___e_n_t_r_y.html" title="ANTLR3_HASH_ENTRY - Hash Table Entry Class Definition" alt="" coords="604,1545,1156,1571"/><area shape="rect" id="node34" href="group___a_n_t_l_r3___c_y_c_l_i_c___d_f_a.html" title="ANTLR3_CYCLIC_DFA - Cyclic DFA Class Definition" alt="" coords="635,1595,1125,1622"/><area shape="rect" id="node35" href="group___a_n_t_l_r3___v_e_c_t_o_r___f_a_c_t_o_r_y.html" title="ANTLR3_VECTOR_FACTORY - Vector Factory Class Definition" alt="" coords="595,1646,1165,1673"/><area shape="rect" id="node36" href="group___a_n_t_l_r3___h_a_s_h___b_u_c_k_e_t.html" title="ANTLR3_HASH_BUCKET - Hash Table Bucket Class Definition" alt="" coords="595,1697,1165,1723"/><area shape="rect" id="node37" href="group___a_n_t_l_r3___t_r_e_e___n_o_d_e___s_t_r_e_a_m.html" title="ANTLR3_TREE_NODE_STREAM - Tree Node Class Definition" alt="" coords="609,1747,1151,1774"/><area shape="rect" id="node38" href="group___a_n_t_l_r3___p_a_r_s_e_r.html" title="ANTLR3_PARSER - Parser Class Definition" alt="" coords="675,1798,1085,1825"/><area shape="rect" id="node39" href="group___a_n_t_l_r3___p_a_r_s_e___t_r_e_e.html" title="ANTLR3_PARSE_TREE - Parse Tree Class Definition" alt="" coords="635,1849,1125,1875"/><area shape="rect" id="node11" href="group__apiclasses.html" title="The API classes are divided into the typdefs (and their underlying structs) that are the containers f..." alt="" coords="7,937,137,963"/></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___i_n_p_u_t___s_t_r_e_a_m__struct.html">ANTLR3_INPUT_STREAM_struct</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Master context structure for an ANTLR3 C runtime based input stream. <a href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="groups"></a>
Modules</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </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">ANTLR3_BASE_RECOGNIZER - Base Recognizer Class Definition</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><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>
<br/></td></tr>
</p>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___r_e_c_o_g_n_i_z_e_r___s_h_a_r_e_d___s_t_a_t_e.html">ANTLR3_RECOGNIZER_SHARED_STATE Recognizer Shared State Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___b_i_t_s_e_t.html">ANTLR3_BITSET - Bitset Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___t_o_k_e_n___f_a_c_t_o_r_y.html">ANTLR3_TOKEN_FACTORY - Token Factory Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n.html">ANTLR3_COMMON_TOKEN - Common Token Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___e_x_c_e_p_t_i_o_n.html">ANTLR3_EXCEPTION - Exception Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___h_a_s_h___b_u_c_k_e_t.html">ANTLR3_HASH_BUCKET - Hash Table Bucket Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___h_a_s_h___e_n_t_r_y.html">ANTLR3_HASH_ENTRY - Hash Table Entry Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___h_a_s_h___e_n_u_m.html">ANTLR3_HASH_ENUM - Hash Table Enumerator Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___h_a_s_h___t_a_b_l_e.html">ANTLR3_HASH_TABLE - Hash Table Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___l_i_s_t.html">ANTLR3_LIST - List Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___v_e_c_t_o_r___f_a_c_t_o_r_y.html">ANTLR3_VECTOR_FACTORY - Vector Factory Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___v_e_c_t_o_r.html">ANTLR3_VECTOR - Vector Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___s_t_a_c_k.html">ANTLR3_STACK - Stack Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m.html">ANTLR3_INPUT_STREAM - Input Stream Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___l_e_x___s_t_a_t_e.html">ANTLR3_LEX_STATE - Lexer State Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___s_t_r_i_n_g___f_a_c_t_o_r_y.html">ANTLR3_STRING_FACTORY - String Factory Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___s_t_r_i_n_g.html">ANTLR3_STRING - String Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___t_o_k_e_n___s_o_u_r_c_e.html">ANTLR3_TOKEN_SOURCE - Token Source Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___t_o_k_e_n___s_t_r_e_a_m.html">ANTLR3_TOKEN_STREAM - Token Stream Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_o_k_e_n___s_t_r_e_a_m.html">ANTLR3_COMMON_TOKEN_STREAM - Common Token Stream Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___c_y_c_l_i_c___d_f_a.html">ANTLR3_CYCLIC_DFA - Cyclic DFA Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___l_e_x_e_r.html">ANTLR3_LEXER - Lexer Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___p_a_r_s_e_r.html">ANTLR3_PARSER - Parser Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___b_a_s_e___t_r_e_e.html">ANTLR3_BASE_TREE - Base Tree Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_r_e_e.html">ANTLR3_COMMON_TREE - Common Tree Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___a_r_b_o_r_e_t_u_m.html">ANTLR3_ARBORETUM - Tree Factory Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___p_a_r_s_e___t_r_e_e.html">ANTLR3_PARSE_TREE - Parse Tree Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___t_r_e_e___n_o_d_e___s_t_r_e_a_m.html">ANTLR3_TREE_NODE_STREAM - Tree Node Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_r_e_e___n_o_d_e___s_t_r_e_a_m.html">ANTLR3_COMMON_TREE_NODE_STREAM - Common Tree Node Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___t_r_e_e___w_a_l_k___s_t_a_t_e.html">ANTLR3_TREE_WALK_STATE - Tree Walk State Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___b_a_s_e___t_r_e_e___a_d_a_p_t_o_r.html">ANTLR3_BASE_TREE_ADAPTOR - Base Tree Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___c_o_m_m_o_n___t_r_e_e___a_d_a_p_t_o_r.html">ANTLR3_COMMON_TREE_ADAPTOR - Common Tree Adaptor Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___t_r_e_e___p_a_r_s_e_r.html">ANTLR3_TREE_PARSER - Tree Parser Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___i_n_t___t_r_i_e.html">ANTLR3_INT_TRIE - Trie Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM - Token Rewrite Stream Class Definition</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_n_t_l_r3___d_e_b_u_g___e_v_e_n_t___l_i_s_t_e_n_e_r.html">ANTLR3_DEBUG_EVENT_LISTENER - Debugger Class Definition</a></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___i_n_p_u_t___s_t_r_e_a_m__struct.html">ANTLR3_INPUT_STREAM_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apistructures.html#ga4dfd330c592f520117952ec2a101e022">ANTLR3_INPUT_STREAM</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Master context structure for an ANTLR3 C runtime based input stream. <a href="#ga4dfd330c592f520117952ec2a101e022"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>These structures (and the typedefs that you use to reference them and their pointers) are the C equivalent of objects. </p>
<p>They correspond (roughly) to the Java runtime system classes and contain all the data elements for a particular interface as well as all the pointers to functions that implement these interfaces.</p>
<p>There are constructor functions exported from the C runtime, which you use to create a default implementation of one of these 'classes'. You can then override any part of the implementation by installing your own function pointers, before using the interface 'object' you have created.</p>
<p>For instance, you can override the default error message reporting function by replacing the standard (example) implementation of this function with your own. In your grammar, you would place the following</p>
<div class="fragment"><pre class="fragment"> @parser::apifuncs
{
<span class="comment">// Install custom error message display</span>
<span class="comment">//</span>
RECOGNIZER->displayRecognitionError = produceError;
}
</pre></div><p>The special section ::apiFuncs is guaranteed to be generated after the RECONGIZER 'object' has already be created and initialized, so you may install your own implementations of the <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> interface functions. The error display function is likely to be the only one you are interested in replacing.</p>
<p>Some typedef structures contain either pointers to 'inherited' objects (usual) or embedded structures/typedefs (unusual). In some cases, the pointers passed around by the paresr or tree parser are actually the pointers to these embedded structures (such as <a class="el" href="group___a_n_t_l_r3___b_a_s_e___t_r_e_e.html#ga6313a8a3e8f044398a393bd10c083852" title="Pointer to an instantiation of 'class' ANTLR3_BASE_TREE.">pANTLR3_BASE_TREE</a>), and these embedded 'objects' contain pointers to their encapsulating objects. This is the equivalent of passing interface objects around in object oriented languages. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga4dfd330c592f520117952ec2a101e022"></a><!-- doxytag: member="antlr3input.h::ANTLR3_INPUT_STREAM" ref="ga4dfd330c592f520117952ec2a101e022" 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___i_n_p_u_t___s_t_r_e_a_m__struct.html">ANTLR3_INPUT_STREAM_struct</a>
<a class="el" href="struct_a_n_t_l_r3___i_n_p_u_t___s_t_r_e_a_m__struct.html">ANTLR3_INPUT_STREAM</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Master context structure for an ANTLR3 C runtime based input stream. </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>
