Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > 058bd62f54850fdc6f0231b268975025 > files > 2287

antlr3-C-docs-3.4-17.mga7.noarch.rpm

<!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/antlr3rewritestreams.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&amp;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
   &#160;<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('antlr3rewritestreams_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle">
<div class="title">antlr3rewritestreams.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="antlr3defs_8h.html">antlr3defs.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="antlr3collections_8h.html">antlr3collections.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="antlr3commontreeadaptor_8h.html">antlr3commontreeadaptor.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="antlr3baserecognizer_8h.html">antlr3baserecognizer.h</a>&gt;</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"  title=" " alt="" coords="1194,5,1403,32"/>
<area shape="rect"  href="antlr3defs_8h.html" title="Basic type and constant definitions for ANTLR3 Runtime." alt="" coords="1166,827,1263,853"/>
<area shape="rect"  href="antlr3collections_8h.html" title=" " alt="" coords="625,677,761,704"/>
<area shape="rect"  href="antlr3commontreeadaptor_8h.html" title="Definition of the ANTLR3 common tree adaptor." alt="" coords="365,304,563,331"/>
<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="1629,80,1792,107"/>
<area shape="rect"  href="antlr3errors_8h.html" title=" " alt="" coords="2167,901,2273,928"/>
<area shape="rect"  title=" " alt="" coords="5,901,115,928"/>
<area shape="rect"  title=" " alt="" coords="139,901,203,928"/>
<area shape="rect"  title=" " alt="" coords="227,901,296,928"/>
<area shape="rect"  title=" " alt="" coords="321,901,410,928"/>
<area shape="rect"  title=" " alt="" coords="435,901,515,928"/>
<area shape="rect"  title=" " alt="" coords="539,901,607,928"/>
<area shape="rect"  title=" " alt="" coords="631,901,705,928"/>
<area shape="rect"  title=" " alt="" coords="729,901,802,928"/>
<area shape="rect"  title=" " alt="" coords="827,901,896,928"/>
<area shape="rect"  title=" " alt="" coords="920,901,995,928"/>
<area shape="rect"  title=" " alt="" coords="1019,901,1101,928"/>
<area shape="rect"  title=" " alt="" coords="1126,901,1197,928"/>
<area shape="rect"  title=" " alt="" coords="1221,901,1315,928"/>
<area shape="rect"  title=" " alt="" coords="1339,901,1435,928"/>
<area shape="rect"  title=" " alt="" coords="1459,901,1560,928"/>
<area shape="rect"  title=" " alt="" coords="1585,901,1703,928"/>
<area shape="rect"  title=" " alt="" coords="1727,901,1798,928"/>
<area shape="rect"  title=" " alt="" coords="1823,901,1897,928"/>
<area shape="rect"  title=" " alt="" coords="1921,901,1988,928"/>
<area shape="rect"  href="antlr3interfaces_8h.html" title="Declarations for all the antlr3 C runtime interfaces/classes." alt="" coords="2012,901,2143,928"/>
<area shape="rect"  href="antlr3convertutf_8h.html" title=" " alt="" coords="2297,901,2431,928"/>
<area shape="rect"  href="antlr3bitset_8h.html" title="Defines the basic structures of an ANTLR3 bitset." alt="" coords="717,752,822,779"/>
<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="761,603,868,629"/>
<area shape="rect"  href="antlr3basetreeadaptor_8h.html" title="Definition of the ANTLR3 base tree adaptor." alt="" coords="603,379,773,405"/>
<area shape="rect"  href="antlr3debugeventlistener_8h.html" title="The definition of all debugging events that a recognizer can trigger." alt="" coords="897,453,1084,480"/>
<area shape="rect"  href="antlr3commontree_8h.html" title=" " alt="" coords="420,453,569,480"/>
<area shape="rect"  href="antlr3basetree_8h.html" title="Definition of the ANTLR3 base tree." alt="" coords="548,528,671,555"/>
<area shape="rect"  href="antlr3commontoken_8h.html" title="Defines the interface for a common token." alt="" coords="1389,603,1549,629"/>
<area shape="rect"  href="antlr3exception_8h.html" title="Contains the definition of a basic ANTLR3 exception structure created by a recognizer when errors are..." alt="" coords="2001,229,2130,256"/>
<area shape="rect"  href="antlr3input_8h.html" title="Defines the basic structures used to manipulate character streams from any input source." alt="" coords="1762,453,1865,480"/>
<area shape="rect"  href="antlr3tokenstream_8h.html" title="Defines the interface for an ANTLR3 common token stream." alt="" coords="1437,379,1585,405"/>
<area shape="rect"  href="antlr3commontreenodestream_8h.html" title="Definition of the ANTLR3 common tree node stream." alt="" coords="894,229,1117,256"/>
<area shape="rect"  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="2065,677,2271,704"/>
<area shape="rect"  href="antlr3lexer_8h.html" title="Base interface for any ANTLR3 lexer." alt="" coords="1661,304,1761,331"/>
<area shape="rect"  href="antlr3parser_8h.html" title="Base implementation of an ANTLR3 parser." alt="" coords="2205,155,2315,181"/>
<area shape="rect"  href="antlr3treeparser_8h.html" title=" " alt="" coords="1188,155,1321,181"/>
<area shape="rect"  href="antlr3intstream_8h.html" title="Defines the the class interface for an antlr3 INTSTREAM." alt="" coords="1405,528,1534,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"  title=" " alt="" coords="288,5,497,32"/>
<area shape="rect"  href="antlr3rewritestreams_8c.html" title="Implementation of token/tree streams that are used by the tree re&#45;write rules to manipulate the token..." alt="" coords="215,80,397,107"/>
<area shape="rect"  href="antlr3_8h.html" title=" " alt="" coords="421,80,540,107"/>
<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="5,155,161,181"/>
<area shape="rect"  href="antlr3commontoken_8c.html" title=" " alt="" coords="185,155,365,181"/>
<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="389,155,572,181"/>
<area shape="rect"  href="antlr3encodings_8c.html" title=" " alt="" coords="596,155,749,181"/>
<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="774,155,926,181"/>
</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 &#160;</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 class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A generic list of elements tracked in an alternative to be used in a -&gt; 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 class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a4d312480f9d98cbae3901993db2c3525"><td class="memItemLeft" align="right" valign="top">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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3rewritestreams_8h.html#a4d312480f9d98cbae3901993db2c3525">ANTLR3_REWRITE_RULE_ELEMENT_STREAM</a></td></tr>
<tr class="memdesc:a4d312480f9d98cbae3901993db2c3525"><td class="mdescLeft">&#160;</td><td class="mdescRight">A generic list of elements tracked in an alternative to be used in a -&gt; rewrite rule.  <a href="#a4d312480f9d98cbae3901993db2c3525">More...</a><br /></td></tr>
<tr class="separator:a4d312480f9d98cbae3901993db2c3525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaad183d9a5128569f8831cf1aa10423b"><td class="memItemLeft" align="right" valign="top">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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3rewritestreams_8h.html#aaad183d9a5128569f8831cf1aa10423b">ANTLR3_REWRITE_RULE_NODE_STREAM</a></td></tr>
<tr class="memdesc:aaad183d9a5128569f8831cf1aa10423b"><td class="mdescLeft">&#160;</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">More...</a><br /></td></tr>
<tr class="separator:aaad183d9a5128569f8831cf1aa10423b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2564ef1d0c6accf3e695c2a3ef220eba"><td class="memItemLeft" align="right" valign="top">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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3rewritestreams_8h.html#a2564ef1d0c6accf3e695c2a3ef220eba">ANTLR3_REWRITE_RULE_SUBTREE_STREAM</a></td></tr>
<tr class="memdesc:a2564ef1d0c6accf3e695c2a3ef220eba"><td class="mdescLeft">&#160;</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">More...</a><br /></td></tr>
<tr class="separator:a2564ef1d0c6accf3e695c2a3ef220eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae91da0f7607835107638b3534526c586"><td class="memItemLeft" align="right" valign="top">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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3rewritestreams_8h.html#ae91da0f7607835107638b3534526c586">ANTLR3_REWRITE_RULE_TOKEN_STREAM</a></td></tr>
<tr class="memdesc:ae91da0f7607835107638b3534526c586"><td class="mdescLeft">&#160;</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">More...</a><br /></td></tr>
<tr class="separator:ae91da0f7607835107638b3534526c586"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a4d312480f9d98cbae3901993db2c3525"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d312480f9d98cbae3901993db2c3525">&#9670;&nbsp;</a></span>ANTLR3_REWRITE_RULE_ELEMENT_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___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="antlr3rewritestreams_8h.html#a4d312480f9d98cbae3901993db2c3525">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 -&gt; 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="section see"><dt>See also</dt><dd><a class="el" href="antlr3interfaces_8h.html#ac687acdf803706344cfbd3f579474274" title="Pointer to an instantiation of &#39;class&#39; 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 &#39;class&#39; 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 &#39;class&#39; #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 id="aaad183d9a5128569f8831cf1aa10423b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaad183d9a5128569f8831cf1aa10423b">&#9670;&nbsp;</a></span>ANTLR3_REWRITE_RULE_NODE_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___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="antlr3rewritestreams_8h.html#aaad183d9a5128569f8831cf1aa10423b">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 id="a2564ef1d0c6accf3e695c2a3ef220eba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2564ef1d0c6accf3e695c2a3ef220eba">&#9670;&nbsp;</a></span>ANTLR3_REWRITE_RULE_SUBTREE_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___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="antlr3rewritestreams_8h.html#a2564ef1d0c6accf3e695c2a3ef220eba">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 id="ae91da0f7607835107638b3534526c586"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae91da0f7607835107638b3534526c586">&#9670;&nbsp;</a></span>ANTLR3_REWRITE_RULE_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___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="antlr3rewritestreams_8h.html#ae91da0f7607835107638b3534526c586">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><!-- 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="antlr3rewritestreams_8h.html">antlr3rewritestreams.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>