<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ANTLR Support Libraries 2.7.1+: TokenStreamRewriteEngine::RewriteOperation Class 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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></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">ANTLR Support Libraries 2.7.1+ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <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&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classTokenStreamRewriteEngine.html">TokenStreamRewriteEngine</a></li><li class="navelem"><a class="el" href="classTokenStreamRewriteEngine_1_1RewriteOperation.html">RewriteOperation</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="classTokenStreamRewriteEngine_1_1RewriteOperation-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">TokenStreamRewriteEngine::RewriteOperation Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="TokenStreamRewriteEngine_8hpp_source.html">TokenStreamRewriteEngine.hpp</a>></code></p> <div class="dynheader"> Inheritance diagram for TokenStreamRewriteEngine::RewriteOperation:</div> <div class="dyncontent"> <div class="center"><img src="classTokenStreamRewriteEngine_1_1RewriteOperation__inherit__graph.png" border="0" usemap="#TokenStreamRewriteEngine_1_1RewriteOperation_inherit__map" alt="Inheritance graph"/></div> <map name="TokenStreamRewriteEngine_1_1RewriteOperation_inherit__map" id="TokenStreamRewriteEngine_1_1RewriteOperation_inherit__map"> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a6b1f951221ce2039526a0f11bf0893cb"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTokenStreamRewriteEngine_1_1RewriteOperation.html#a6b1f951221ce2039526a0f11bf0893cb">~RewriteOperation</a> ()</td></tr> <tr class="separator:a6b1f951221ce2039526a0f11bf0893cb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a56be67596228c7524403c21d7972318d"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTokenStreamRewriteEngine_1_1RewriteOperation.html#a56be67596228c7524403c21d7972318d">execute</a> (std ::ostream &)</td></tr> <tr class="separator:a56be67596228c7524403c21d7972318d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2592aac017e11019a7d1227fafab0540"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTokenStreamRewriteEngine_1_1RewriteOperation.html#a2592aac017e11019a7d1227fafab0540">getIndex</a> () const</td></tr> <tr class="separator:a2592aac017e11019a7d1227fafab0540"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a724b9163ad91585641c165b62794a7ee"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTokenStreamRewriteEngine_1_1RewriteOperation.html#a724b9163ad91585641c165b62794a7ee">type</a> () const</td></tr> <tr class="separator:a724b9163ad91585641c165b62794a7ee"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a89555f2aa6f6981cf53901c588173358"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTokenStreamRewriteEngine_1_1RewriteOperation.html#a89555f2aa6f6981cf53901c588173358">RewriteOperation</a> (size_t idx, const std ::string &txt)</td></tr> <tr class="separator:a89555f2aa6f6981cf53901c588173358"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:ad260f22b94777f69bd8b0e8d5f05e294"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTokenStreamRewriteEngine_1_1RewriteOperation.html#ad260f22b94777f69bd8b0e8d5f05e294">index</a></td></tr> <tr class="separator:ad260f22b94777f69bd8b0e8d5f05e294"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad589204a972ff5fa42bb40f47757a9db"><td class="memItemLeft" align="right" valign="top">std ::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTokenStreamRewriteEngine_1_1RewriteOperation.html#ad589204a972ff5fa42bb40f47757a9db">text</a></td></tr> <tr class="separator:ad589204a972ff5fa42bb40f47757a9db"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a89555f2aa6f6981cf53901c588173358"></a> <h2 class="memtitle"><span class="permalink"><a href="#a89555f2aa6f6981cf53901c588173358">◆ </a></span>RewriteOperation()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">TokenStreamRewriteEngine::RewriteOperation::RewriteOperation </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"><em>idx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std ::string & </td> <td class="paramname"><em>txt</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="a6b1f951221ce2039526a0f11bf0893cb"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6b1f951221ce2039526a0f11bf0893cb">◆ </a></span>~RewriteOperation()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual TokenStreamRewriteEngine::RewriteOperation::~RewriteOperation </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a56be67596228c7524403c21d7972318d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a56be67596228c7524403c21d7972318d">◆ </a></span>execute()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual size_t TokenStreamRewriteEngine::RewriteOperation::execute </td> <td>(</td> <td class="paramtype">std ::ostream & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Execute the rewrite operation by possibly adding to the buffer. Return the index of the next token to operate on. </p> <p>Reimplemented in <a class="el" href="classTokenStreamRewriteEngine_1_1ReplaceOp.html#ae355b75d733bd416bd76220261e49db7">TokenStreamRewriteEngine::ReplaceOp</a>, and <a class="el" href="classTokenStreamRewriteEngine_1_1InsertBeforeOp.html#ac2e22c249382836edeeda2b679b3d2ce">TokenStreamRewriteEngine::InsertBeforeOp</a>.</p> </div> </div> <a id="a2592aac017e11019a7d1227fafab0540"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2592aac017e11019a7d1227fafab0540">◆ </a></span>getIndex()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual size_t TokenStreamRewriteEngine::RewriteOperation::getIndex </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="a724b9163ad91585641c165b62794a7ee"></a> <h2 class="memtitle"><span class="permalink"><a href="#a724b9163ad91585641c165b62794a7ee">◆ </a></span>type()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const char* TokenStreamRewriteEngine::RewriteOperation::type </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplemented in <a class="el" href="classTokenStreamRewriteEngine_1_1DeleteOp.html#a3a269d1a09faded4c74301ed68e298ba">TokenStreamRewriteEngine::DeleteOp</a>, <a class="el" href="classTokenStreamRewriteEngine_1_1ReplaceOp.html#a54a2172c142e162377db5ef3601d7753">TokenStreamRewriteEngine::ReplaceOp</a>, and <a class="el" href="classTokenStreamRewriteEngine_1_1InsertBeforeOp.html#afc0c2213452de331f38150fab11b4e8d">TokenStreamRewriteEngine::InsertBeforeOp</a>.</p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a id="ad260f22b94777f69bd8b0e8d5f05e294"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad260f22b94777f69bd8b0e8d5f05e294">◆ </a></span>index</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">size_t TokenStreamRewriteEngine::RewriteOperation::index</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a id="ad589204a972ff5fa42bb40f47757a9db"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad589204a972ff5fa42bb40f47757a9db">◆ </a></span>text</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std ::string TokenStreamRewriteEngine::RewriteOperation::text</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>antlr/<a class="el" href="TokenStreamRewriteEngine_8hpp_source.html">TokenStreamRewriteEngine.hpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>