<!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>ANTLR Support Libraries 2.7.1+: antlr/AST.hpp Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <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">ANTLR Support Libraries 2.7.1+</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="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </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>File Members</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <h1>antlr/AST.hpp</h1> </div> </div> <div class="contents"> <a href="AST_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef INC_AST_hpp__</span> <a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define INC_AST_hpp__</span> <a name="l00003"></a>00003 <span class="preprocessor"></span> <a name="l00004"></a>00004 <span class="comment">/* ANTLR Translator Generator</span> <a name="l00005"></a>00005 <span class="comment"> * Project led by Terence Parr at http://www.jGuru.com</span> <a name="l00006"></a>00006 <span class="comment"> * Software rights: http://www.antlr.org/license.html</span> <a name="l00007"></a>00007 <span class="comment"> *</span> <a name="l00008"></a>00008 <span class="comment"> * $Id: //depot/code/org.antlr/release/antlr-2.7.7/lib/cpp/antlr/AST.hpp#2 $</span> <a name="l00009"></a>00009 <span class="comment"> */</span> <a name="l00010"></a>00010 <a name="l00011"></a>00011 <span class="preprocessor">#include <antlr/config.hpp></span> <a name="l00012"></a>00012 <span class="preprocessor">#include <antlr/ASTRefCount.hpp></span> <a name="l00013"></a>00013 <span class="preprocessor">#include <antlr/Token.hpp></span> <a name="l00014"></a>00014 <span class="preprocessor">#include <vector></span> <a name="l00015"></a>00015 <span class="preprocessor">#include <string></span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="keyword">namespace </span>antlr { <a name="l00019"></a>00019 <span class="preprocessor">#endif</span> <a name="l00020"></a>00020 <span class="preprocessor"></span> <a name="l00021"></a>00021 <span class="keyword">struct </span><a class="code" href="structASTRef.html">ASTRef</a>; <a name="l00022"></a>00022 <a name="l00023"></a><a class="code" href="classAST.html">00023</a> <span class="keyword">class </span><a class="code" href="config_8hpp.html#ad583892c7af76867441115e41aa1ce52">ANTLR_API</a> <a class="code" href="classAST.html">AST</a> { <a name="l00024"></a>00024 <span class="keyword">public</span>: <a name="l00025"></a><a class="code" href="classAST.html#afd378ca7cb3049d6293e8597d31d758d">00025</a> <a class="code" href="classAST.html#afd378ca7cb3049d6293e8597d31d758d">AST</a>() : ref(0) {} <a name="l00026"></a><a class="code" href="classAST.html#a9ec56dd0d1a68b46fd7b10ac14bee798">00026</a> <a class="code" href="classAST.html#a9ec56dd0d1a68b46fd7b10ac14bee798">AST</a>(<span class="keyword">const</span> <a class="code" href="classAST.html">AST</a>&) : ref(0) {} <a name="l00027"></a><a class="code" href="classAST.html#a8838ed6f77c9e42d452f463e55da756d">00027</a> <span class="keyword">virtual</span> <a class="code" href="classAST.html#a8838ed6f77c9e42d452f463e55da756d">~AST</a>() {} <a name="l00028"></a>00028 <a name="l00030"></a>00030 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* typeName( <span class="keywordtype">void</span> ) <span class="keyword">const</span> = 0; <a name="l00032"></a>00032 <span class="keyword">virtual</span> <a class="code" href="classASTRefCount.html">RefAST</a> clone( <span class="keywordtype">void</span> ) <span class="keyword">const</span> = 0; <a name="l00034"></a>00034 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> equals(<a class="code" href="classASTRefCount.html">RefAST</a> t) <span class="keyword">const</span> = 0; <a name="l00038"></a>00038 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> equalsList(<a class="code" href="classASTRefCount.html">RefAST</a> t) <span class="keyword">const</span> = 0; <a name="l00039"></a>00039 <a name="l00042"></a>00042 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> equalsListPartial(<a class="code" href="classASTRefCount.html">RefAST</a> t) <span class="keyword">const</span> = 0; <a name="l00046"></a>00046 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> equalsTree(<a class="code" href="classASTRefCount.html">RefAST</a> t) <span class="keyword">const</span> = 0; <a name="l00050"></a>00050 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> equalsTreePartial(<a class="code" href="classASTRefCount.html">RefAST</a> t) <span class="keyword">const</span> = 0; <a name="l00051"></a>00051 <a name="l00056"></a>00056 <span class="keyword">virtual</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)vector<<a class="code" href="classASTRefCount.html">RefAST</a>> findAll(<a class="code" href="classASTRefCount.html">RefAST</a> t) = 0; <a name="l00057"></a>00057 <a name="l00062"></a>00062 virtual <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)vector<<a class="code" href="classASTRefCount.html">RefAST</a>> findAllPartial(<a class="code" href="classASTRefCount.html">RefAST</a> t) = 0; <a name="l00063"></a>00063 <a name="l00065"></a>00065 virtual <span class="keywordtype">void</span> addChild(<a class="code" href="classASTRefCount.html">RefAST</a> c) = 0; <a name="l00067"></a>00067 virtual <span class="keywordtype">size_t</span> getNumberOfChildren() const = 0; <a name="l00068"></a>00068 <a name="l00070"></a>00070 virtual <a class="code" href="classASTRefCount.html">RefAST</a> getFirstChild() const = 0; <a name="l00072"></a>00072 virtual <a class="code" href="classASTRefCount.html">RefAST</a> getNextSibling() const = 0; <a name="l00073"></a>00073 <a name="l00075"></a>00075 virtual <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)<span class="keywordtype">string</span> getText() const = 0; <a name="l00077"></a>00077 virtual <span class="keywordtype">int</span> getType() const = 0; <a name="l00078"></a>00078 <a name="l00082"></a>00082 virtual <span class="keywordtype">void</span> initialize(<span class="keywordtype">int</span> t, const <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)<span class="keywordtype">string</span>& txt) = 0; <a name="l00083"></a>00083 virtual <span class="keywordtype">void</span> initialize(<a class="code" href="classASTRefCount.html">RefAST</a> t) = 0; <a name="l00084"></a>00084 virtual <span class="keywordtype">void</span> initialize(<a class="code" href="classTokenRefCount.html">RefToken</a> t) = 0; <a name="l00085"></a>00085 <a name="l00086"></a>00086 <span class="preprocessor">#ifdef ANTLR_SUPPORT_XML</span> <a name="l00087"></a>00087 <span class="preprocessor"></span> <a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keywordtype">void</span> initialize( <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)istream& in ) = 0; <a name="l00091"></a>00091 <span class="preprocessor">#endif</span> <a name="l00092"></a>00092 <span class="preprocessor"></span> <a name="l00094"></a>00094 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setFirstChild(<a class="code" href="classASTRefCount.html">RefAST</a> c) = 0; <a name="l00096"></a>00096 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setNextSibling(<a class="code" href="classASTRefCount.html">RefAST</a> n) = 0; <a name="l00097"></a>00097 <a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setText(<span class="keyword">const</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)<span class="keywordtype">string</span>& txt) = 0; <a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setType(<span class="keywordtype">int</span> type) = 0; <a name="l00102"></a>00102 <a name="l00104"></a>00104 <span class="keyword">virtual</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)string toString() const = 0; <a name="l00105"></a>00105 <a name="l00107"></a>00107 virtual <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)<span class="keywordtype">string</span> toStringList() const = 0; <a name="l00108"></a>00108 virtual <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)<span class="keywordtype">string</span> toStringTree() const = 0; <a name="l00109"></a>00109 <a name="l00110"></a>00110 <span class="preprocessor">#ifdef ANTLR_SUPPORT_XML</span> <a name="l00111"></a>00111 <span class="preprocessor"></span> <a name="l00116"></a>00116 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> attributesToStream( <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)ostream& out ) <span class="keyword">const</span> = 0; <a name="l00117"></a>00117 <a name="l00122"></a>00122 <span class="keyword">virtual</span> <span class="keywordtype">void</span> toStream( <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)ostream &out ) <span class="keyword">const</span> = 0; <a name="l00123"></a>00123 <a name="l00130"></a>00130 <span class="keyword">friend</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)ostream& operator<<( <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)ostream& output, const <a class="code" href="classASTRefCount.html">RefAST</a>& ast ); <a name="l00131"></a>00131 <span class="preprocessor">#endif</span> <a name="l00132"></a>00132 <span class="preprocessor"></span> <a name="l00133"></a>00133 <span class="keyword">private</span>: <a name="l00134"></a><a class="code" href="classAST.html#a21e276750f3f5e31030629e2dcf61744">00134</a> <span class="keyword">friend</span> <span class="keyword">struct </span><a class="code" href="structASTRef.html">ASTRef</a>; <a name="l00135"></a><a class="code" href="classAST.html#a1e1699aef7a83c4454b502013973ee7e">00135</a> <a class="code" href="structASTRef.html">ASTRef</a>* <a class="code" href="classAST.html#a1e1699aef7a83c4454b502013973ee7e">ref</a>; <a name="l00136"></a>00136 <a name="l00137"></a>00137 <a class="code" href="classAST.html">AST</a>(<a class="code" href="classASTRefCount.html">RefAST</a> other); <a name="l00138"></a>00138 <a class="code" href="classAST.html">AST</a>& <a class="code" href="structASTRef.html#aab017a0b12821599ae151e859dda9e23">operator=</a>(<span class="keyword">const</span> <a class="code" href="classAST.html">AST</a>& other); <a name="l00139"></a>00139 <a class="code" href="classAST.html">AST</a>& <a class="code" href="structASTRef.html#aab017a0b12821599ae151e859dda9e23">operator=</a>(<a class="code" href="classASTRefCount.html">RefAST</a> other); <a name="l00140"></a>00140 }; <a name="l00141"></a>00141 <a name="l00142"></a>00142 <span class="preprocessor">#ifdef ANTLR_SUPPORT_XML</span> <a name="l00143"></a>00143 <span class="preprocessor"></span><span class="keyword">inline</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)ostream& operator<<( <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(std)ostream& output, const <a class="code" href="classASTRefCount.html">RefAST</a>& ast ) <a name="l00144"></a>00144 { <a name="l00145"></a>00145 ast->toStream(output); <a name="l00146"></a>00146 <span class="keywordflow">return</span> output; <a name="l00147"></a>00147 } <a name="l00148"></a>00148 <span class="preprocessor">#endif</span> <a name="l00149"></a>00149 <span class="preprocessor"></span> <a name="l00150"></a>00150 <span class="keyword">extern</span> <a class="code" href="config_8hpp.html#ad583892c7af76867441115e41aa1ce52">ANTLR_API</a> <a class="code" href="classASTRefCount.html">RefAST</a> <a class="code" href="AST_8hpp.html#aef5cde6de81efc04d3b318e3dc5863ff">nullAST</a>; <a name="l00151"></a>00151 <span class="keyword">extern</span> <a class="code" href="config_8hpp.html#ad583892c7af76867441115e41aa1ce52">ANTLR_API</a> <a class="code" href="classAST.html">AST</a>* <span class="keyword">const</span> <a class="code" href="AST_8hpp.html#a4dc54139411b117dc076cc655c955aea">nullASTptr</a>; <a name="l00152"></a>00152 <a name="l00153"></a>00153 <span class="preprocessor">#ifdef NEEDS_OPERATOR_LESS_THAN</span> <a name="l00154"></a>00154 <span class="preprocessor"></span><span class="comment">// RK: apparently needed by MSVC and a SUN CC, up to and including</span> <a name="l00155"></a>00155 <span class="comment">// 2.7.2 this was undefined ?</span> <a name="l00156"></a>00156 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator<( <a class="code" href="classASTRefCount.html">RefAST</a> l, <a class="code" href="classASTRefCount.html">RefAST</a> r ) <a name="l00157"></a>00157 { <a name="l00158"></a>00158 <span class="keywordflow">return</span> <a class="code" href="AST_8hpp.html#aef5cde6de81efc04d3b318e3dc5863ff">nullAST</a> == l ? ( <a class="code" href="AST_8hpp.html#aef5cde6de81efc04d3b318e3dc5863ff">nullAST</a> == r ? <span class="keyword">false</span> : true ) : l->getType() < r->getType(); <a name="l00159"></a>00159 } <a name="l00160"></a>00160 <span class="preprocessor">#endif</span> <a name="l00161"></a>00161 <span class="preprocessor"></span> <a name="l00162"></a>00162 <span class="preprocessor">#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE</span> <a name="l00163"></a>00163 <span class="preprocessor"></span>} <a name="l00164"></a>00164 <span class="preprocessor">#endif</span> <a name="l00165"></a>00165 <span class="preprocessor"></span> <a name="l00166"></a>00166 <span class="preprocessor">#endif //INC_AST_hpp__</span> </pre></div></div> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Fri Mar 25 2011 for ANTLR Support Libraries 2.7.1+ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>