<!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_PARSE_TREE_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 <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 class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data 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___p_a_r_s_e___t_r_e_e__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_PARSE_TREE_struct Struct Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ANTLR3_PARSE_TREE_struct" -->
<p><code>#include <antlr3parsetree.h></code></p>
<div class="dynheader">
Collaboration diagram for ANTLR3_PARSE_TREE_struct:</div>
<div class="dyncontent">
<div class="center"><img src="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct__coll__graph.png" border="0" usemap="#_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct_coll__map" alt="Collaboration graph"/></div>
<map name="_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct_coll__map" id="_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct_coll__map">
<area shape="rect" id="node2" 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="337,117,559,144"/><area shape="rect" id="node5" 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="196,305,497,332"/><area shape="rect" id="node12" href="struct_a_n_t_l_r3___b_a_s_e___t_r_e_e__struct.html" title="A generic tree implementation with no payload." alt="" coords="205,627,456,653"/><area shape="rect" id="node14" 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="421,536,704,563"/><area shape="rect" id="node17" 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="577,436,860,463"/><area shape="rect" id="node20" 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="521,305,783,332"/><area shape="rect" id="node8" href="struct_a_n_t_l_r3___v_e_c_t_o_r__struct.html" title="ANTLR3_VECTOR_struct" alt="" coords="901,117,1123,144"/><area shape="rect" id="node10" 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="861,5,1163,32"/></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="struct_a_n_t_l_r3___b_a_s_e___t_r_e_e__struct.html">ANTLR3_BASE_TREE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#adf29cfa8ac886a0292c8ec5e21859a65">baseTree</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An encapsulated BASE TREE strcuture (NOT a pointer) that perfoms a lot of the dirty work of node management. <a href="#adf29cfa8ac886a0292c8ec5e21859a65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___b_a_s_e___t_r_e_e__struct.html">pANTLR3_BASE_TREE</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#a164cc1d674b62141c5ef0fda35107077">dupNode</a> )(struct <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> *tree)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">How to dup this node. <a href="#a164cc1d674b62141c5ef0fda35107077"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#aff34d95f433312b2483b89082fb598c9">free</a> )(struct <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> *tree)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="antlr3defs_8h.html#ac41f744abd0fd25144b9eb9d11b1dfd1">ANTLR3_UINT32</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#a409c3365960de7a7e06ee2f98fc067df">getType</a> )(struct <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> *tree)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the type of this node. <a href="#a409c3365960de7a7e06ee2f98fc067df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#ac014f0f8331803c4fa11bc196bbcb052">payload</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The payload that the parse tree node passes around. <a href="#ac014f0f8331803c4fa11bc196bbcb052"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#a1170ffff19fe53a48dc3cad2b56babeb">super</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Any interface that implements methods in this interface may need to point back to itself using this pointer to its super structure. <a href="#a1170ffff19fe53a48dc3cad2b56babeb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html">pANTLR3_STRING</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#a58505143179c17cd36041a6d2688e1ec">toString</a> )(struct <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> *<a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#ac014f0f8331803c4fa11bc196bbcb052">payload</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the string representation of the payload (must be installed when the payload is added and point to a function that knwos how to manifest a pANTLR3_STRING from a node. <a href="#a58505143179c17cd36041a6d2688e1ec"></a><br/></td></tr>
</table>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="adf29cfa8ac886a0292c8ec5e21859a65"></a><!-- doxytag: member="ANTLR3_PARSE_TREE_struct::baseTree" ref="adf29cfa8ac886a0292c8ec5e21859a65" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_a_n_t_l_r3___b_a_s_e___t_r_e_e__struct.html">ANTLR3_BASE_TREE</a> <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#adf29cfa8ac886a0292c8ec5e21859a65">ANTLR3_PARSE_TREE_struct::baseTree</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An encapsulated BASE TREE strcuture (NOT a pointer) that perfoms a lot of the dirty work of node management. </p>
</div>
</div>
<a class="anchor" id="a164cc1d674b62141c5ef0fda35107077"></a><!-- doxytag: member="ANTLR3_PARSE_TREE_struct::dupNode" ref="a164cc1d674b62141c5ef0fda35107077" args=")(struct ANTLR3_PARSE_TREE_struct *tree)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_a_n_t_l_r3___b_a_s_e___t_r_e_e__struct.html">pANTLR3_BASE_TREE</a>(* <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#a164cc1d674b62141c5ef0fda35107077">ANTLR3_PARSE_TREE_struct::dupNode</a>)(struct <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> *tree)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>How to dup this node. </p>
</div>
</div>
<a class="anchor" id="aff34d95f433312b2483b89082fb598c9"></a><!-- doxytag: member="ANTLR3_PARSE_TREE_struct::free" ref="aff34d95f433312b2483b89082fb598c9" args=")(struct ANTLR3_PARSE_TREE_struct *tree)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#aff34d95f433312b2483b89082fb598c9">ANTLR3_PARSE_TREE_struct::free</a>)(struct <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> *tree)</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a409c3365960de7a7e06ee2f98fc067df"></a><!-- doxytag: member="ANTLR3_PARSE_TREE_struct::getType" ref="a409c3365960de7a7e06ee2f98fc067df" args=")(struct ANTLR3_PARSE_TREE_struct *tree)" -->
<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___p_a_r_s_e___t_r_e_e__struct.html#a409c3365960de7a7e06ee2f98fc067df">ANTLR3_PARSE_TREE_struct::getType</a>)(struct <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> *tree)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the type of this node. </p>
</div>
</div>
<a class="anchor" id="ac014f0f8331803c4fa11bc196bbcb052"></a><!-- doxytag: member="ANTLR3_PARSE_TREE_struct::payload" ref="ac014f0f8331803c4fa11bc196bbcb052" 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___p_a_r_s_e___t_r_e_e__struct.html#ac014f0f8331803c4fa11bc196bbcb052">ANTLR3_PARSE_TREE_struct::payload</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The payload that the parse tree node passes around. </p>
</div>
</div>
<a class="anchor" id="a1170ffff19fe53a48dc3cad2b56babeb"></a><!-- doxytag: member="ANTLR3_PARSE_TREE_struct::super" ref="a1170ffff19fe53a48dc3cad2b56babeb" 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___p_a_r_s_e___t_r_e_e__struct.html#a1170ffff19fe53a48dc3cad2b56babeb">ANTLR3_PARSE_TREE_struct::super</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Any interface that implements methods in this interface may need to point back to itself using this pointer to its super structure. </p>
</div>
</div>
<a class="anchor" id="a58505143179c17cd36041a6d2688e1ec"></a><!-- doxytag: member="ANTLR3_PARSE_TREE_struct::toString" ref="a58505143179c17cd36041a6d2688e1ec" args=")(struct ANTLR3_PARSE_TREE_struct *payload)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html">pANTLR3_STRING</a>(* <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#a58505143179c17cd36041a6d2688e1ec">ANTLR3_PARSE_TREE_struct::toString</a>)(struct <a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> *<a class="el" href="struct_a_n_t_l_r3___p_a_r_s_e___t_r_e_e__struct.html#ac014f0f8331803c4fa11bc196bbcb052">payload</a>)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the string representation of the payload (must be installed when the payload is added and point to a function that knwos how to manifest a pANTLR3_STRING from a node. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="antlr3parsetree_8h.html">antlr3parsetree.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___p_a_r_s_e___t_r_e_e__struct.html">ANTLR3_PARSE_TREE_struct</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for ANTLR3C by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
