<!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+: LexerInputState 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="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> | <a href="#pri-methods">Private Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <h1>LexerInputState Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="LexerInputState" --> <p><code>#include <<a class="el" href="LexerSharedInputState_8hpp_source.html">LexerSharedInputState.hpp</a>></code></p> <div class="dynheader"> Collaboration diagram for LexerInputState:</div> <div class="dyncontent"> <div class="center"><img src="classLexerInputState__coll__graph.png" border="0" usemap="#LexerInputState_coll__map" alt="Collaboration graph"/></div> <map name="LexerInputState_coll__map" id="LexerInputState_coll__map"> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classLexerInputState-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a761a7986cdf2c596da605d414d6b0acc">LexerInputState</a> (<a class="el" href="classInputBuffer.html">InputBuffer</a> *inbuf)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#ab55fe1d85ad0cfbd73de8792e82df3ba">LexerInputState</a> (<a class="el" href="classInputBuffer.html">InputBuffer</a> &inbuf)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a5b1dc4dd262ec9020e83838568f341e1">LexerInputState</a> (std::istream &in)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a5c4a4117843bd9c8de74aa01e35d1cf3">initialize</a> (std::istream &in, const char *file="")</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a90031004476b4038df477a296a58e1d9">reset</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a88da82742fede7394126a594f9091718">setPosition</a> (int line_, int column_)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a242bf81a50c2ec322e055a5d8f630e45">~LexerInputState</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classInputBuffer.html">InputBuffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a4963d26ec751799e5d9125c8a43a0a4c">getInput</a> ()</td></tr> <tr><td colspan="2"><h2><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a95755ff2a0553db02185f5ac9be2e685">column</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#afeeef67d7ee619e132725e0edc7c746d">line</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a630cdd779d3603629749c21d124c0415">tokenStartColumn</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a05c430823bae52a5b33d82d64c6c20b6">tokenStartLine</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a9d5c90f3b64b88abdc255d19e6a8cd62">guessing</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#aa1985b4b16fe3c6d80db85c157e3b6ed">filename</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="classLexerInputState.html#af1f38649fe316be92f1b93933c3bcee1">LexerInputState</a> (const <a class="el" href="classLexerInputState.html">LexerInputState</a> &)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classLexerInputState.html">LexerInputState</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#a3834337218f78ba65c68c748c4d5e2a6">operator=</a> (const <a class="el" href="classLexerInputState.html">LexerInputState</a> &)</td></tr> <tr><td colspan="2"><h2><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classInputBuffer.html">InputBuffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#ab0d7f9674fe51205e75a3f5b96b2ff8c">input</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Input buffer we use. <a href="#ab0d7f9674fe51205e75a3f5b96b2ff8c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classLexerInputState.html#aaa6b4786114c7e2cab97e9c0f6f030df">inputResponsible</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Who is responsible for cleaning up the <a class="el" href="classInputBuffer.html">InputBuffer</a>? <a href="#aaa6b4786114c7e2cab97e9c0f6f030df"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>This object contains the data associated with an input stream of characters. Multiple lexers share a single LexerSharedInputState to lex the same input stream. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a761a7986cdf2c596da605d414d6b0acc"></a><!-- doxytag: member="LexerInputState::LexerInputState" ref="a761a7986cdf2c596da605d414d6b0acc" args="(InputBuffer *inbuf)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">LexerInputState::LexerInputState </td> <td>(</td> <td class="paramtype"><a class="el" href="classInputBuffer.html">InputBuffer</a> * </td> <td class="paramname"><em>inbuf</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a new <a class="el" href="classLexerInputState.html">LexerInputState</a> </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">inbuf</td><td>the <a class="el" href="classInputBuffer.html">InputBuffer</a> to read from. The object is deleted together with the <a class="el" href="classLexerInputState.html">LexerInputState</a> object. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ab55fe1d85ad0cfbd73de8792e82df3ba"></a><!-- doxytag: member="LexerInputState::LexerInputState" ref="ab55fe1d85ad0cfbd73de8792e82df3ba" args="(InputBuffer &inbuf)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">LexerInputState::LexerInputState </td> <td>(</td> <td class="paramtype"><a class="el" href="classInputBuffer.html">InputBuffer</a> & </td> <td class="paramname"><em>inbuf</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a new <a class="el" href="classLexerInputState.html">LexerInputState</a> </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">inbuf</td><td>the <a class="el" href="classInputBuffer.html">InputBuffer</a> to read from. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a5b1dc4dd262ec9020e83838568f341e1"></a><!-- doxytag: member="LexerInputState::LexerInputState" ref="a5b1dc4dd262ec9020e83838568f341e1" args="(std::istream &in)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">LexerInputState::LexerInputState </td> <td>(</td> <td class="paramtype">std::istream & </td> <td class="paramname"><em>in</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a new <a class="el" href="classLexerInputState.html">LexerInputState</a> </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">in</td><td>an istream to read from. </td></tr> </table> </dd> </dl> <dl class="see"><dt><b>See also:</b></dt><dd>antlr.CharBuffer </dd></dl> </div> </div> <a class="anchor" id="a242bf81a50c2ec322e055a5d8f630e45"></a><!-- doxytag: member="LexerInputState::~LexerInputState" ref="a242bf81a50c2ec322e055a5d8f630e45" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual LexerInputState::~LexerInputState </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="af1f38649fe316be92f1b93933c3bcee1"></a><!-- doxytag: member="LexerInputState::LexerInputState" ref="af1f38649fe316be92f1b93933c3bcee1" args="(const LexerInputState &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">LexerInputState::LexerInputState </td> <td>(</td> <td class="paramtype">const <a class="el" href="classLexerInputState.html">LexerInputState</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="a4963d26ec751799e5d9125c8a43a0a4c"></a><!-- doxytag: member="LexerInputState::getInput" ref="a4963d26ec751799e5d9125c8a43a0a4c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classInputBuffer.html">InputBuffer</a> & LexerInputState::getInput </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a5c4a4117843bd9c8de74aa01e35d1cf3"></a><!-- doxytag: member="LexerInputState::initialize" ref="a5c4a4117843bd9c8de74aa01e35d1cf3" args="(std::istream &in, const char *file="")" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void LexerInputState::initialize </td> <td>(</td> <td class="paramtype">std::istream & </td> <td class="paramname"><em>in</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>file</em> = <code>""</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Reset the <a class="el" href="classLexerInputState.html">LexerInputState</a> with a specified stream and filename. This method is a hack, dunno what I was thinking when I added it. This should actually be done in a subclass. </p> <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd></dd></dl> </div> </div> <a class="anchor" id="a3834337218f78ba65c68c748c4d5e2a6"></a><!-- doxytag: member="LexerInputState::operator=" ref="a3834337218f78ba65c68c748c4d5e2a6" args="(const LexerInputState &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classLexerInputState.html">LexerInputState</a>& LexerInputState::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classLexerInputState.html">LexerInputState</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="a90031004476b4038df477a296a58e1d9"></a><!-- doxytag: member="LexerInputState::reset" ref="a90031004476b4038df477a296a58e1d9" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void LexerInputState::reset </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Reset the <a class="el" href="classLexerInputState.html">LexerInputState</a> to initial state. The underlying <a class="el" href="classInputBuffer.html">InputBuffer</a> is also reset. </p> </div> </div> <a class="anchor" id="a88da82742fede7394126a594f9091718"></a><!-- doxytag: member="LexerInputState::setPosition" ref="a88da82742fede7394126a594f9091718" args="(int line_, int column_)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void LexerInputState::setPosition </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>line_</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>column_</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set the file position of the SharedLexerInputState. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">line_</td><td>line number to be set </td></tr> <tr><td class="paramname">column_</td><td>column number to be set </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a95755ff2a0553db02185f5ac9be2e685"></a><!-- doxytag: member="LexerInputState::column" ref="a95755ff2a0553db02185f5ac9be2e685" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classLexerInputState.html#a95755ff2a0553db02185f5ac9be2e685">LexerInputState::column</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aa1985b4b16fe3c6d80db85c157e3b6ed"></a><!-- doxytag: member="LexerInputState::filename" ref="aa1985b4b16fe3c6d80db85c157e3b6ed" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std ::string <a class="el" href="classLexerInputState.html#aa1985b4b16fe3c6d80db85c157e3b6ed">LexerInputState::filename</a></td> </tr> </table> </div> <div class="memdoc"> <p>What file (if known) caused the problem? </p> </div> </div> <a class="anchor" id="a9d5c90f3b64b88abdc255d19e6a8cd62"></a><!-- doxytag: member="LexerInputState::guessing" ref="a9d5c90f3b64b88abdc255d19e6a8cd62" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classLexerInputState.html#a9d5c90f3b64b88abdc255d19e6a8cd62">LexerInputState::guessing</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ab0d7f9674fe51205e75a3f5b96b2ff8c"></a><!-- doxytag: member="LexerInputState::input" ref="ab0d7f9674fe51205e75a3f5b96b2ff8c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classInputBuffer.html">InputBuffer</a>* <a class="el" href="classLexerInputState.html#ab0d7f9674fe51205e75a3f5b96b2ff8c">LexerInputState::input</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Input buffer we use. </p> </div> </div> <a class="anchor" id="aaa6b4786114c7e2cab97e9c0f6f030df"></a><!-- doxytag: member="LexerInputState::inputResponsible" ref="aaa6b4786114c7e2cab97e9c0f6f030df" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classLexerInputState.html#aaa6b4786114c7e2cab97e9c0f6f030df">LexerInputState::inputResponsible</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Who is responsible for cleaning up the <a class="el" href="classInputBuffer.html">InputBuffer</a>? </p> </div> </div> <a class="anchor" id="afeeef67d7ee619e132725e0edc7c746d"></a><!-- doxytag: member="LexerInputState::line" ref="afeeef67d7ee619e132725e0edc7c746d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classLexerInputState.html#afeeef67d7ee619e132725e0edc7c746d">LexerInputState::line</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a630cdd779d3603629749c21d124c0415"></a><!-- doxytag: member="LexerInputState::tokenStartColumn" ref="a630cdd779d3603629749c21d124c0415" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classLexerInputState.html#a630cdd779d3603629749c21d124c0415">LexerInputState::tokenStartColumn</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a05c430823bae52a5b33d82d64c6c20b6"></a><!-- doxytag: member="LexerInputState::tokenStartLine" ref="a05c430823bae52a5b33d82d64c6c20b6" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classLexerInputState.html#a05c430823bae52a5b33d82d64c6c20b6">LexerInputState::tokenStartLine</a></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="LexerSharedInputState_8hpp_source.html">LexerSharedInputState.hpp</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>