<!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+: Parser Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<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="#pri-methods">Private Member Functions</a> </div>
<div class="headertitle">
<h1>Parser Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Parser" -->
<p><code>#include <<a class="el" href="Parser_8hpp_source.html">Parser.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for Parser:</div>
<div class="dyncontent">
<div class="center"><img src="classParser__inherit__graph.png" border="0" usemap="#Parser_inherit__map" alt="Inheritance graph"/></div>
<map name="Parser_inherit__map" id="Parser_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Parser:</div>
<div class="dyncontent">
<div class="center"><img src="classParser__coll__graph.png" border="0" usemap="#Parser_coll__map" alt="Collaboration graph"/></div>
<map name="Parser_coll__map" id="Parser_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classParser-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser_1_1Tracer.html">Tracer</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ad576b92b9cc324f6f41b0269a9a1a546">~Parser</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a8ffde97c771e9db73d153745bd1bedd4">LA</a> (unsigned int i)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classTokenRefCount.html">RefToken</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ab28969d536dc9dedfe1079f2248d0511">LT</a> (unsigned int i)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the i-th token of lookahead. <a href="#ab28969d536dc9dedfe1079f2248d0511"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a4b0c787d880ad93863ba1eaa3c438ddd">setASTNodeFactory</a> (<a class="el" href="classASTFactory.html">ASTFactory</a> *factory)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ab617d899c66421200dc2c8f1c613f891">setASTFactory</a> (<a class="el" href="classASTFactory.html">ASTFactory</a> *factory)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classASTFactory.html">ASTFactory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a895e2ae879484a122417cc7c5a123329">getASTFactory</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classASTRefCount.html">RefAST</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a6f4bd9c5b3f75fbdcba769df14e706cc">getAST</a> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a357a385d715fa19f1f557d8ca6e6a3d3">getFilename</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the filename of the input file. <a href="#a357a385d715fa19f1f557d8ca6e6a3d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a10ec46fb2ce1c0b040d5485aee4309c3">setFilename</a> (const std::string &f)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the filename of the input file (used for error reporting). <a href="#a10ec46fb2ce1c0b040d5485aee4309c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a162e3c3d1a3f69237e61c33ffb04f75c">setInputState</a> (<a class="el" href="classRefCount.html">ParserSharedInputState</a> state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRefCount.html">ParserSharedInputState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a4751a94d3daba13d468f03f537539d9a">getInputState</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a34e6c885f633e20c50f4df7369fccdb4">consume</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get another token object from the token stream. <a href="#a34e6c885f633e20c50f4df7369fccdb4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a7f2907c8df6c5f799be1d2237b5cf493">consumeUntil</a> (int tokenType)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Consume tokens until one matches the given token. <a href="#a7f2907c8df6c5f799be1d2237b5cf493"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ad5b1e73f84668166dc065616b6e070f8">consumeUntil</a> (const <a class="el" href="classBitSet.html">BitSet</a> &set)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Consume tokens until one matches the given token set. <a href="#ad5b1e73f84668166dc065616b6e070f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#af28bc2e0ecd7a4aa0ef2b726d9306d81">match</a> (int t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ad97c8acdc37baaefde9d15e936817807">matchNot</a> (int t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a33d918b15806aaa7c5eb2980a4a08d19">match</a> (const <a class="el" href="classBitSet.html">BitSet</a> &b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a2f644171f723c2f61da8871e98aeef54">mark</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a72eb09a927be17981cb54fc4b3df2955">rewind</a> (unsigned int pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">rewind to a previously marked position <a href="#a72eb09a927be17981cb54fc4b3df2955"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ae0431fe2780445a13b0af6fd9f770869">recover</a> (const RecognitionException &ex, const <a class="el" href="classBitSet.html">BitSet</a> &tokenSet)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#afd91748d4f7073d53021b8fabf222dcb">reportError</a> (const RecognitionException &ex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classParser.html">Parser</a> error-reporting function can be overridden in subclass. <a href="#afd91748d4f7073d53021b8fabf222dcb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a8fb960a3e5d67ff9ea6467a33d940aaa">reportError</a> (const std::string &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classParser.html">Parser</a> error-reporting function can be overridden in subclass. <a href="#a8fb960a3e5d67ff9ea6467a33d940aaa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a8e714e85277eecc3034d054c8a872a67">reportWarning</a> (const std::string &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classParser.html">Parser</a> warning-reporting function can be overridden in subclass. <a href="#a8e714e85277eecc3034d054c8a872a67"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a610135736da16cf29e247c257f2d0b16">getTokenName</a> (int num) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the token name for the token number 'num' <a href="#a610135736da16cf29e247c257f2d0b16"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ac7c39058d987c389662190928cc6185e">getTokenNames</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get a vector with all token names <a href="#ac7c39058d987c389662190928cc6185e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a557c0433a3e6a926786e223de94c4fcf">getNumTokens</a> (void) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a0fd40e8f66dd7741a7440555ad6855af">traceIndent</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ae96f73ef3841edadb0cad22ea35e66d0">traceIn</a> (const char *rname)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a57b4665fd23899df2e07f243ed05a944">traceOut</a> (const char *rname)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#aaf50e67812d3deebc19da08082d560bf">Parser</a> (<a class="el" href="classTokenBuffer.html">TokenBuffer</a> &input)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ac4277c75e0bd33af85a7b3d8d410ec21">Parser</a> (<a class="el" href="classTokenBuffer.html">TokenBuffer</a> *input)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a25848e55d2fb40e11589c79e92da6d66">Parser</a> (const <a class="el" href="classRefCount.html">ParserSharedInputState</a> &state)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRefCount.html">ParserSharedInputState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#add867b57c3af7bdd636160b165577570">inputState</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classASTFactory.html">ASTFactory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a47ba690eae07029a628c46512f504517">astFactory</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classAST.html">AST</a> support code; parser and treeparser delegate to this object. <a href="#a47ba690eae07029a628c46512f504517"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#a017bf3d95a7b2538279bb9d2e307db43">traceDepth</a></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#acf58c19ff11509154be1606a4cf48a6c">Parser</a> (const <a class="el" href="classParser.html">Parser</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classParser.html">Parser</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classParser.html#ad01ad4145d506ab22d4e60c5cbe343cb">operator=</a> (const <a class="el" href="classParser.html">Parser</a> &)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A generic ANTLR parser (LL(k) for k>=1) containing a bunch of utility routines useful at any lookahead depth. We distinguish between the LL(1) and LL(k) parsers because of efficiency. This may not be necessary in the near future.</p>
<p>Each parser object contains the state of the parse including a lookahead cache (the form of which is determined by the subclass), whether or not the parser is in guess mode, where tokens come from, etc...</p>
<p>During <b>guess</b> mode, the current lookahead token(s) and token type(s) cache must be saved because the token stream may not have been informed to save the token (via <code>mark</code>) before the <code>try</code> block. Guessing is started by: </p>
<ol>
<li>
saving the lookahead cache. </li>
<li>
marking the current position in the <a class="el" href="classTokenBuffer.html">TokenBuffer</a>. </li>
<li>
increasing the guessing level. </li>
</ol>
<p>After guessing, the parser state is restored by: </p>
<ol>
<li>
restoring the lookahead cache. </li>
<li>
rewinding the <a class="el" href="classTokenBuffer.html">TokenBuffer</a>. </li>
<li>
decreasing the guessing level. </li>
</ol>
<dl class="see"><dt><b>See also:</b></dt><dd>antlr.Token </dd>
<dd>
antlr.TokenBuffer </dd>
<dd>
antlr.TokenStream </dd>
<dd>
antlr.LL1Parser </dd>
<dd>
antlr.LLkParser</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>add constructors with <a class="el" href="classASTFactory.html">ASTFactory</a>. </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aaf50e67812d3deebc19da08082d560bf"></a><!-- doxytag: member="Parser::Parser" ref="aaf50e67812d3deebc19da08082d560bf" args="(TokenBuffer &input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Parser::Parser </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTokenBuffer.html">TokenBuffer</a> & </td>
<td class="paramname"><em>input</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac4277c75e0bd33af85a7b3d8d410ec21"></a><!-- doxytag: member="Parser::Parser" ref="ac4277c75e0bd33af85a7b3d8d410ec21" args="(TokenBuffer *input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Parser::Parser </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTokenBuffer.html">TokenBuffer</a> * </td>
<td class="paramname"><em>input</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a25848e55d2fb40e11589c79e92da6d66"></a><!-- doxytag: member="Parser::Parser" ref="a25848e55d2fb40e11589c79e92da6d66" args="(const ParserSharedInputState &state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Parser::Parser </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRefCount.html">ParserSharedInputState</a> & </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad576b92b9cc324f6f41b0269a9a1a546"></a><!-- doxytag: member="Parser::~Parser" ref="ad576b92b9cc324f6f41b0269a9a1a546" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Parser::~Parser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acf58c19ff11509154be1606a4cf48a6c"></a><!-- doxytag: member="Parser::Parser" ref="acf58c19ff11509154be1606a4cf48a6c" args="(const Parser &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Parser::Parser </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classParser.html">Parser</a> & </td>
<td class="paramname"></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a34e6c885f633e20c50f4df7369fccdb4"></a><!-- doxytag: member="Parser::consume" ref="a34e6c885f633e20c50f4df7369fccdb4" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::consume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get another token object from the token stream. </p>
<p>Implemented in <a class="el" href="classLLkParser.html#ac2ec6b36dcef64815419165aaf71961f">LLkParser</a>.</p>
</div>
</div>
<a class="anchor" id="a7f2907c8df6c5f799be1d2237b5cf493"></a><!-- doxytag: member="Parser::consumeUntil" ref="a7f2907c8df6c5f799be1d2237b5cf493" args="(int tokenType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::consumeUntil </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>tokenType</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Consume tokens until one matches the given token. </p>
</div>
</div>
<a class="anchor" id="ad5b1e73f84668166dc065616b6e070f8"></a><!-- doxytag: member="Parser::consumeUntil" ref="ad5b1e73f84668166dc065616b6e070f8" args="(const BitSet &set)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::consumeUntil </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBitSet.html">BitSet</a> & </td>
<td class="paramname"><em>set</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Consume tokens until one matches the given token set. </p>
</div>
</div>
<a class="anchor" id="a6f4bd9c5b3f75fbdcba769df14e706cc"></a><!-- doxytag: member="Parser::getAST" ref="a6f4bd9c5b3f75fbdcba769df14e706cc" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classASTRefCount.html">RefAST</a> Parser::getAST </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the root <a class="el" href="classAST.html">AST</a> node of the generated <a class="el" href="classAST.html">AST</a>. When using a custom <a class="el" href="classAST.html">AST</a> type or heterogenous AST's, you'll have to convert it to the right type yourself. </p>
</div>
</div>
<a class="anchor" id="a895e2ae879484a122417cc7c5a123329"></a><!-- doxytag: member="Parser::getASTFactory" ref="a895e2ae879484a122417cc7c5a123329" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classASTFactory.html">ASTFactory</a>* Parser::getASTFactory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the <a class="el" href="classASTFactory.html">ASTFactory</a> used. So you might use it in subsequent treewalkers or to reload AST's from disk. </p>
</div>
</div>
<a class="anchor" id="a357a385d715fa19f1f557d8ca6e6a3d3"></a><!-- doxytag: member="Parser::getFilename" ref="a357a385d715fa19f1f557d8ca6e6a3d3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std ::string Parser::getFilename </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the filename of the input file. </p>
</div>
</div>
<a class="anchor" id="a4751a94d3daba13d468f03f537539d9a"></a><!-- doxytag: member="Parser::getInputState" ref="a4751a94d3daba13d468f03f537539d9a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRefCount.html">ParserSharedInputState</a> Parser::getInputState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a557c0433a3e6a926786e223de94c4fcf"></a><!-- doxytag: member="Parser::getNumTokens" ref="a557c0433a3e6a926786e223de94c4fcf" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Parser::getNumTokens </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of tokens defined. This one should be overridden in subclasses. </p>
</div>
</div>
<a class="anchor" id="a610135736da16cf29e247c257f2d0b16"></a><!-- doxytag: member="Parser::getTokenName" ref="a610135736da16cf29e247c257f2d0b16" args="(int num) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Parser::getTokenName </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>num</em></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the token name for the token number 'num' </p>
</div>
</div>
<a class="anchor" id="ac7c39058d987c389662190928cc6185e"></a><!-- doxytag: member="Parser::getTokenNames" ref="ac7c39058d987c389662190928cc6185e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* const Parser::getTokenNames </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get a vector with all token names </p>
</div>
</div>
<a class="anchor" id="a8ffde97c771e9db73d153745bd1bedd4"></a><!-- doxytag: member="Parser::LA" ref="a8ffde97c771e9db73d153745bd1bedd4" args="(unsigned int i)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Parser::LA </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>i</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the token type of the ith token of lookahead where i=1 is the current token being examined by the parser (i.e., it has not been matched yet). </p>
<p>Implemented in <a class="el" href="classLLkParser.html#a485c4b0c48915c4ad9c3b700e23c91a0">LLkParser</a>.</p>
</div>
</div>
<a class="anchor" id="ab28969d536dc9dedfe1079f2248d0511"></a><!-- doxytag: member="Parser::LT" ref="ab28969d536dc9dedfe1079f2248d0511" args="(unsigned int i)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTokenRefCount.html">RefToken</a> Parser::LT </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>i</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the i-th token of lookahead. </p>
<p>Implemented in <a class="el" href="classLLkParser.html#af9daf3179f61e9e8e97c27d8e525aeb4">LLkParser</a>.</p>
</div>
</div>
<a class="anchor" id="a2f644171f723c2f61da8871e98aeef54"></a><!-- doxytag: member="Parser::mark" ref="a2f644171f723c2f61da8871e98aeef54" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int Parser::mark </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Mark a spot in the input and return the position. Forwarded to <a class="el" href="classTokenBuffer.html">TokenBuffer</a>. </p>
</div>
</div>
<a class="anchor" id="a33d918b15806aaa7c5eb2980a4a08d19"></a><!-- doxytag: member="Parser::match" ref="a33d918b15806aaa7c5eb2980a4a08d19" args="(const BitSet &b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::match </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBitSet.html">BitSet</a> & </td>
<td class="paramname"><em>b</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Make sure current lookahead symbol matches the given set Throw an exception upon mismatch, which is catch by either the error handler or by the syntactic predicate. </p>
</div>
</div>
<a class="anchor" id="af28bc2e0ecd7a4aa0ef2b726d9306d81"></a><!-- doxytag: member="Parser::match" ref="af28bc2e0ecd7a4aa0ef2b726d9306d81" args="(int t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::match </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Make sure current lookahead symbol matches token type <code>t</code>. Throw an exception upon mismatch, which is catch by either the error handler or by the syntactic predicate. </p>
</div>
</div>
<a class="anchor" id="ad97c8acdc37baaefde9d15e936817807"></a><!-- doxytag: member="Parser::matchNot" ref="ad97c8acdc37baaefde9d15e936817807" args="(int t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::matchNot </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad01ad4145d506ab22d4e60c5cbe343cb"></a><!-- doxytag: member="Parser::operator=" ref="ad01ad4145d506ab22d4e60c5cbe343cb" args="(const Parser &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classParser.html">Parser</a>& Parser::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classParser.html">Parser</a> & </td>
<td class="paramname"></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae0431fe2780445a13b0af6fd9f770869"></a><!-- doxytag: member="Parser::recover" ref="ae0431fe2780445a13b0af6fd9f770869" args="(const RecognitionException &ex, const BitSet &tokenSet)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::recover </td>
<td>(</td>
<td class="paramtype">const RecognitionException & </td>
<td class="paramname"><em>ex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classBitSet.html">BitSet</a> & </td>
<td class="paramname"><em>tokenSet</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>called by the generated parser to do error recovery, override to customize the behaviour. </p>
</div>
</div>
<a class="anchor" id="afd91748d4f7073d53021b8fabf222dcb"></a><!-- doxytag: member="Parser::reportError" ref="afd91748d4f7073d53021b8fabf222dcb" args="(const RecognitionException &ex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Parser::reportError </td>
<td>(</td>
<td class="paramtype">const RecognitionException & </td>
<td class="paramname"><em>ex</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classParser.html">Parser</a> error-reporting function can be overridden in subclass. </p>
<p><a class="el" href="classParser.html">Parser</a> error-reporting function can be overridden in subclass </p>
</div>
</div>
<a class="anchor" id="a8fb960a3e5d67ff9ea6467a33d940aaa"></a><!-- doxytag: member="Parser::reportError" ref="a8fb960a3e5d67ff9ea6467a33d940aaa" args="(const std::string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Parser::reportError </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classParser.html">Parser</a> error-reporting function can be overridden in subclass. </p>
<p><a class="el" href="classParser.html">Parser</a> error-reporting function can be overridden in subclass </p>
</div>
</div>
<a class="anchor" id="a8e714e85277eecc3034d054c8a872a67"></a><!-- doxytag: member="Parser::reportWarning" ref="a8e714e85277eecc3034d054c8a872a67" args="(const std::string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Parser::reportWarning </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classParser.html">Parser</a> warning-reporting function can be overridden in subclass. </p>
<p><a class="el" href="classParser.html">Parser</a> warning-reporting function can be overridden in subclass </p>
</div>
</div>
<a class="anchor" id="a72eb09a927be17981cb54fc4b3df2955"></a><!-- doxytag: member="Parser::rewind" ref="a72eb09a927be17981cb54fc4b3df2955" args="(unsigned int pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::rewind </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>pos</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>rewind to a previously marked position </p>
</div>
</div>
<a class="anchor" id="ab617d899c66421200dc2c8f1c613f891"></a><!-- doxytag: member="Parser::setASTFactory" ref="ab617d899c66421200dc2c8f1c613f891" args="(ASTFactory *factory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::setASTFactory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classASTFactory.html">ASTFactory</a> * </td>
<td class="paramname"><em>factory</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify the factory to be used during tree building. (Compulsory) Setting the factory is nowadays compulsory. </p>
</div>
</div>
<a class="anchor" id="a4b0c787d880ad93863ba1eaa3c438ddd"></a><!-- doxytag: member="Parser::setASTNodeFactory" ref="a4b0c787d880ad93863ba1eaa3c438ddd" args="(ASTFactory *factory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::setASTNodeFactory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classASTFactory.html">ASTFactory</a> * </td>
<td class="paramname"><em>factory</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>DEPRECATED! Specify the factory to be used during tree building. (Compulsory) Setting the factory is nowadays compulsory. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classParser.html#ab617d899c66421200dc2c8f1c613f891">setASTFactory</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a10ec46fb2ce1c0b040d5485aee4309c3"></a><!-- doxytag: member="Parser::setFilename" ref="a10ec46fb2ce1c0b040d5485aee4309c3" args="(const std::string &f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::setFilename </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the filename of the input file (used for error reporting). </p>
</div>
</div>
<a class="anchor" id="a162e3c3d1a3f69237e61c33ffb04f75c"></a><!-- doxytag: member="Parser::setInputState" ref="a162e3c3d1a3f69237e61c33ffb04f75c" args="(ParserSharedInputState state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Parser::setInputState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRefCount.html">ParserSharedInputState</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae96f73ef3841edadb0cad22ea35e66d0"></a><!-- doxytag: member="Parser::traceIn" ref="ae96f73ef3841edadb0cad22ea35e66d0" args="(const char *rname)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Parser::traceIn </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>rname</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classLLkParser.html#a1cda240c1ac889a7d11ee3e17943c22a">LLkParser</a>.</p>
</div>
</div>
<a class="anchor" id="a0fd40e8f66dd7741a7440555ad6855af"></a><!-- doxytag: member="Parser::traceIndent" ref="a0fd40e8f66dd7741a7440555ad6855af" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Parser::traceIndent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set or change the input token buffer </p>
</div>
</div>
<a class="anchor" id="a57b4665fd23899df2e07f243ed05a944"></a><!-- doxytag: member="Parser::traceOut" ref="a57b4665fd23899df2e07f243ed05a944" args="(const char *rname)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Parser::traceOut </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>rname</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classLLkParser.html#aeb85303f5036937f2e67353a1ee4a038">LLkParser</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a47ba690eae07029a628c46512f504517"></a><!-- doxytag: member="Parser::astFactory" ref="a47ba690eae07029a628c46512f504517" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classASTFactory.html">ASTFactory</a>* <a class="el" href="classParser.html#a47ba690eae07029a628c46512f504517">Parser::astFactory</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classAST.html">AST</a> support code; parser and treeparser delegate to this object. </p>
</div>
</div>
<a class="anchor" id="add867b57c3af7bdd636160b165577570"></a><!-- doxytag: member="Parser::inputState" ref="add867b57c3af7bdd636160b165577570" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCount.html">ParserSharedInputState</a> <a class="el" href="classParser.html#add867b57c3af7bdd636160b165577570">Parser::inputState</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a017bf3d95a7b2538279bb9d2e307db43"></a><!-- doxytag: member="Parser::traceDepth" ref="a017bf3d95a7b2538279bb9d2e307db43" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classParser.html#a017bf3d95a7b2538279bb9d2e307db43">Parser::traceDepth</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>antlr/<a class="el" href="Parser_8hpp_source.html">Parser.hpp</a></li>
<li>src/<a class="el" href="Parser_8cpp.html">Parser.cpp</a></li>
</ul>
</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>
