<!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: include/antlr3rewritestreams.h File 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><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</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('antlr3rewritestreams_8h.html','');
</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">
<h1>antlr3rewritestreams.h File Reference</h1> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="antlr3defs_8h.html">antlr3defs.h</a>></code><br/>
<code>#include <<a class="el" href="antlr3collections_8h.html">antlr3collections.h</a>></code><br/>
<code>#include <<a class="el" href="antlr3commontreeadaptor_8h.html">antlr3commontreeadaptor.h</a>></code><br/>
<code>#include <<a class="el" href="antlr3baserecognizer_8h.html">antlr3baserecognizer.h</a>></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for antlr3rewritestreams.h:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3rewritestreams_8h__incl.png" border="0" usemap="#include_2antlr3rewritestreams_8h" alt=""/></div>
<map name="include_2antlr3rewritestreams_8h" id="include_2antlr3rewritestreams_8h">
<area shape="rect" id="node3" href="antlr3defs_8h.html" title="Basic type and constant definitions for ANTLR3 Runtime." alt="" coords="1027,827,1168,853"/><area shape="rect" id="node16" href="antlr3collections_8h.html" title="antlr3collections.h" alt="" coords="391,677,601,704"/><area shape="rect" id="node23" href="antlr3commontreeadaptor_8h.html" title="Definition of the ANTLR3 common tree adaptor." alt="" coords="260,304,532,331"/><area shape="rect" id="node55" href="antlr3baserecognizer_8h.html" title="Defines the basic structure to support recognizing by either a lexer, parser, or tree parser..." alt="" coords="1463,80,1705,107"/><area shape="rect" id="node5" href="antlr3errors_8h.html" title="antlr3errors.h" alt="" coords="593,901,756,928"/><area shape="rect" id="node11" href="antlr3interfaces_8h.html" title="Declarations for all the antlr3 C runtime interfaces/classes." alt="" coords="1081,901,1284,928"/><area shape="rect" id="node13" href="antlr3convertutf_8h.html" title="antlr3convertutf.h" alt="" coords="1308,901,1511,928"/><area shape="rect" id="node19" href="antlr3bitset_8h.html" title="Defines the basic structures of an ANTLR3 bitset." alt="" coords="533,752,696,779"/><area shape="rect" id="node27" href="antlr3string_8h.html" title="Simple string interface allows indiscriminate allocation of strings such that they can be allocated a..." alt="" coords="584,603,747,629"/><area shape="rect" id="node31" href="antlr3basetreeadaptor_8h.html" title="Definition of the ANTLR3 base tree adaptor." alt="" coords="347,379,597,405"/><area shape="rect" id="node44" href="antlr3debugeventlistener_8h.html" title="The definition of all debugging events that a recognizer can trigger." alt="" coords="928,453,1211,480"/><area shape="rect" id="node49" href="antlr3commontree_8h.html" title="antlr3commontree.h" alt="" coords="600,453,803,480"/><area shape="rect" id="node36" href="antlr3basetree_8h.html" title="Definition of the ANTLR3 base tree." alt="" coords="549,528,731,555"/><area shape="rect" id="node41" href="antlr3commontoken_8h.html" title="Defines the interface for a common token." alt="" coords="1252,603,1463,629"/><area shape="rect" id="node58" href="antlr3exception_8h.html" title="Contains the definition of a basic ANTLR3 exception structure created by a recognizer when errors are..." alt="" coords="1865,229,2057,256"/><area shape="rect" id="node61" href="antlr3input_8h.html" title="Defines the basic structures used to manipulate character streams from any input source." alt="" coords="1539,453,1691,480"/><area shape="rect" id="node70" href="antlr3tokenstream_8h.html" title="Defines the interface for an ANTLR3 common token stream." alt="" coords="1285,379,1496,405"/><area shape="rect" id="node80" href="antlr3commontreenodestream_8h.html" title="Definition of the ANTLR3 common tree node stream." alt="" coords="653,229,955,256"/><area shape="rect" id="node89" href="antlr3recognizersharedstate_8h.html" title="While the C runtime does not need to model the state of multiple lexers and parsers in the same way a..." alt="" coords="1968,677,2280,704"/><area shape="rect" id="node92" href="antlr3lexer_8h.html" title="Base interface for any ANTLR3 lexer." alt="" coords="1621,304,1773,331"/><area shape="rect" id="node99" href="antlr3parser_8h.html" title="Base implementation of an ANTLR3 parser." alt="" coords="2132,155,2295,181"/><area shape="rect" id="node103" href="antlr3treeparser_8h.html" title="antlr3treeparser.h" alt="" coords="957,155,1160,181"/><area shape="rect" id="node66" href="antlr3intstream_8h.html" title="Defines the the class interface for an antlr3 INTSTREAM." alt="" coords="1261,528,1453,555"/></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="antlr3rewritestreams_8h__dep__incl.png" border="0" usemap="#include_2antlr3rewritestreams_8hdep" alt=""/></div>
<map name="include_2antlr3rewritestreams_8hdep" id="include_2antlr3rewritestreams_8hdep">
<area shape="rect" id="node3" href="antlr3_8h.html" title="include/antlr3.h" alt="" coords="76,80,257,107"/></map>
</div>
</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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A generic list of elements tracked in an alternative to be used in a -> rewrite rule. <a href="struct_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__struct.html#_details">More...</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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3rewritestreams_8h.html#a4d312480f9d98cbae3901993db2c3525">ANTLR3_REWRITE_RULE_ELEMENT_STREAM</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A generic list of elements tracked in an alternative to be used in a -> rewrite rule. <a href="#a4d312480f9d98cbae3901993db2c3525"></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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3rewritestreams_8h.html#aaad183d9a5128569f8831cf1aa10423b">ANTLR3_REWRITE_RULE_NODE_STREAM</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an implementation of a node stream, which is basically an element stream that deals with tree nodes only. <a href="#aaad183d9a5128569f8831cf1aa10423b"></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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3rewritestreams_8h.html#a2564ef1d0c6accf3e695c2a3ef220eba">ANTLR3_REWRITE_RULE_SUBTREE_STREAM</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an implementation of a subtree stream which is a set of trees modelled as an element stream. <a href="#a2564ef1d0c6accf3e695c2a3ef220eba"></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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3rewritestreams_8h.html#ae91da0f7607835107638b3534526c586">ANTLR3_REWRITE_RULE_TOKEN_STREAM</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is an implementation of a token stream, which is basically an element stream that deals with tokens only. <a href="#ae91da0f7607835107638b3534526c586"></a><br/></td></tr>
</table>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a4d312480f9d98cbae3901993db2c3525"></a><!-- doxytag: member="antlr3rewritestreams.h::ANTLR3_REWRITE_RULE_ELEMENT_STREAM" ref="a4d312480f9d98cbae3901993db2c3525" 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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a>
<a class="el" href="struct_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__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A generic list of elements tracked in an alternative to be used in a -> rewrite rule. </p>
<p>In the C implementation, all tree oriented streams return a pointer to the same type: pANTLR3_BASE_TREE. Anything that has subclassed from this still passes this type, within which there is a super pointer, which points to it's own data and methods. Hence we do not need to implement this as the equivalent of an abstract class, but just fill in the appropriate interface as usual with this model.</p>
<p>Once you start <a class="el" href="antlr3rewritestreams_8c.html#a92c4d9fcaea24e9f6b4f658711bacc07" title="Return the next element in the stream.">next()</a>ing, do not try to add more elements. It will break the cursor tracking I believe.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="antlr3interfaces_8h.html#ac687acdf803706344cfbd3f579474274" title="Pointer to an instantiation of 'class' ANTLR3_REWRITE_RULE_NODE_STREAM.">pANTLR3_REWRITE_RULE_NODE_STREAM</a> </dd>
<dd>
<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#gae7733833bf686184837d5eb2cdb5a53a" title="Pointer to an instantiation of 'class' ANTLR3_REWRITE_RULE_ELEMENT_STREAM.">pANTLR3_REWRITE_RULE_ELEMENT_STREAM</a> </dd>
<dd>
<a class="el" href="antlr3interfaces_8h.html#a5f81a145b3cf4347ec31698e7a14ca49" title="Pointer to an instantiation of 'class' #ANTLR3_REWRITE_RULE_SUBSTREE_STREAM.">pANTLR3_REWRITE_RULE_SUBTREE_STREAM</a></dd></dl>
<p>TODO: add mechanism to detect/puke on modification after reading from stream </p>
</div>
</div>
<a class="anchor" id="aaad183d9a5128569f8831cf1aa10423b"></a><!-- doxytag: member="antlr3rewritestreams.h::ANTLR3_REWRITE_RULE_NODE_STREAM" ref="aaad183d9a5128569f8831cf1aa10423b" 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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a> <a class="el" href="struct_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__struct.html">ANTLR3_REWRITE_RULE_NODE_STREAM</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is an implementation of a node stream, which is basically an element stream that deals with tree nodes only. </p>
</div>
</div>
<a class="anchor" id="a2564ef1d0c6accf3e695c2a3ef220eba"></a><!-- doxytag: member="antlr3rewritestreams.h::ANTLR3_REWRITE_RULE_SUBTREE_STREAM" ref="a2564ef1d0c6accf3e695c2a3ef220eba" 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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a> <a class="el" href="struct_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__struct.html">ANTLR3_REWRITE_RULE_SUBTREE_STREAM</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is an implementation of a subtree stream which is a set of trees modelled as an element stream. </p>
</div>
</div>
<a class="anchor" id="ae91da0f7607835107638b3534526c586"></a><!-- doxytag: member="antlr3rewritestreams.h::ANTLR3_REWRITE_RULE_TOKEN_STREAM" ref="ae91da0f7607835107638b3534526c586" 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___r_e_w_r_i_t_e___r_u_l_e___e_l_e_m_e_n_t___s_t_r_e_a_m__struct.html">ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct</a> <a class="el" href="struct_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__struct.html">ANTLR3_REWRITE_RULE_TOKEN_STREAM</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is an implementation of a token stream, which is basically an element stream that deals with tokens only. </p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="antlr3rewritestreams_8h.html">antlr3rewritestreams.h</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>
