<!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+: CommonToken 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-static-methods">Static Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-methods">Private Member Functions</a> </div>
<div class="headertitle">
<h1>CommonToken Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CommonToken" --><!-- doxytag: inherits="Token" -->
<p><code>#include <<a class="el" href="CommonToken_8hpp_source.html">CommonToken.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for CommonToken:</div>
<div class="dyncontent">
<div class="center"><img src="classCommonToken__inherit__graph.png" border="0" usemap="#CommonToken_inherit__map" alt="Inheritance graph"/></div>
<map name="CommonToken_inherit__map" id="CommonToken_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CommonToken:</div>
<div class="dyncontent">
<div class="center"><img src="classCommonToken__coll__graph.png" border="0" usemap="#CommonToken_coll__map" alt="Collaboration graph"/></div>
<map name="CommonToken_coll__map" id="CommonToken_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCommonToken-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="classCommonToken.html#a0664eac7660b9aa8e0e672b865730370">CommonToken</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a66d98a73534cb2a90ae9586bf99747f5">CommonToken</a> (int t, const std::string &txt)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#ac5ee2b2654807b7640da0efb6a38799d">CommonToken</a> (const std::string &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a623a687f1626b2161f81c7189887ac7a">getText</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return contents of token <a href="#a623a687f1626b2161f81c7189887ac7a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a173fd55a632bfd7c54479669de4bbac4">setText</a> (const std::string &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set contents of token <a href="#a173fd55a632bfd7c54479669de4bbac4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a7f8277b42387719d55f2e832fdffd49e">getLine</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#af3fa5b0744cb83ab60b77799ddefd410">getColumn</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a329f255e68b263713d564f07462bf48a">setLine</a> (int l)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set line for token <a href="#a329f255e68b263713d564f07462bf48a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#aee8c0028292030a49450cf9dfc4b6a53">setColumn</a> (int c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set column for token <a href="#aee8c0028292030a49450cf9dfc4b6a53"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#abd71ac0c79cb7adc17d5d0a2a4d83368">toString</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classTokenRefCount.html">RefToken</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a38c5cec6cb290ae1cc15b2eddd3c7ae9">factory</a> ()</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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a0d89014eedf28a833115301623666dfa">line</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a2a2d73eb8de862352a088737b1e07fe0">col</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#aad557464aad3d523859018dc1773d21c">text</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="classCommonToken.html#a8200c061bc8b62c1a6b430f87f5164d0">CommonToken</a> (const <a class="el" href="classCommonToken.html">CommonToken</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCommonToken.html">CommonToken</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonToken.html#a096cc2c7323d0637a26da4a783f255f3">operator=</a> (const <a class="el" href="classCommonToken.html">CommonToken</a> &)</td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0664eac7660b9aa8e0e672b865730370"></a><!-- doxytag: member="CommonToken::CommonToken" ref="a0664eac7660b9aa8e0e672b865730370" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CommonToken::CommonToken </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a66d98a73534cb2a90ae9586bf99747f5"></a><!-- doxytag: member="CommonToken::CommonToken" ref="a66d98a73534cb2a90ae9586bf99747f5" args="(int t, const std::string &txt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CommonToken::CommonToken </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>t</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>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac5ee2b2654807b7640da0efb6a38799d"></a><!-- doxytag: member="CommonToken::CommonToken" ref="ac5ee2b2654807b7640da0efb6a38799d" args="(const std::string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CommonToken::CommonToken </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8200c061bc8b62c1a6b430f87f5164d0"></a><!-- doxytag: member="CommonToken::CommonToken" ref="a8200c061bc8b62c1a6b430f87f5164d0" args="(const CommonToken &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CommonToken::CommonToken </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCommonToken.html">CommonToken</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="a38c5cec6cb290ae1cc15b2eddd3c7ae9"></a><!-- doxytag: member="CommonToken::factory" ref="a38c5cec6cb290ae1cc15b2eddd3c7ae9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTokenRefCount.html">RefToken</a> CommonToken::factory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classCommonHiddenStreamToken.html#ae911ebefa37103150577e0338d32a15c">CommonHiddenStreamToken</a>.</p>
</div>
</div>
<a class="anchor" id="af3fa5b0744cb83ab60b77799ddefd410"></a><!-- doxytag: member="CommonToken::getColumn" ref="af3fa5b0744cb83ab60b77799ddefd410" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int CommonToken::getColumn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>gt the column the token is at (starting at 1) </p>
<dl class="see"><dt><b>See also:</b></dt><dd>CharScanner::newline() </dd>
<dd>
CharScanner::tab() </dd></dl>
<p>Reimplemented from <a class="el" href="classToken.html#a58ae7fd2789154c6f44a9607cf29e1e3">Token</a>.</p>
</div>
</div>
<a class="anchor" id="a7f8277b42387719d55f2e832fdffd49e"></a><!-- doxytag: member="CommonToken::getLine" ref="a7f8277b42387719d55f2e832fdffd49e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int CommonToken::getLine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the line the token is at (starting at 1) </p>
<dl class="see"><dt><b>See also:</b></dt><dd>CharScanner::newline() </dd>
<dd>
CharScanner::tab() </dd></dl>
<p>Reimplemented from <a class="el" href="classToken.html#aabf52369794e69f418cf58c6191d473a">Token</a>.</p>
</div>
</div>
<a class="anchor" id="a623a687f1626b2161f81c7189887ac7a"></a><!-- doxytag: member="CommonToken::getText" ref="a623a687f1626b2161f81c7189887ac7a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std ::string CommonToken::getText </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return contents of token </p>
<p>Reimplemented from <a class="el" href="classToken.html#a4b5041a76adc9ecd919a6836207d6a40">Token</a>.</p>
</div>
</div>
<a class="anchor" id="a096cc2c7323d0637a26da4a783f255f3"></a><!-- doxytag: member="CommonToken::operator=" ref="a096cc2c7323d0637a26da4a783f255f3" args="(const CommonToken &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCommonToken.html">CommonToken</a>& CommonToken::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCommonToken.html">CommonToken</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="aee8c0028292030a49450cf9dfc4b6a53"></a><!-- doxytag: member="CommonToken::setColumn" ref="aee8c0028292030a49450cf9dfc4b6a53" args="(int c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CommonToken::setColumn </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set column for token </p>
<p>Reimplemented from <a class="el" href="classToken.html#a229e85d69832a05e9f1ea544799e19c0">Token</a>.</p>
</div>
</div>
<a class="anchor" id="a329f255e68b263713d564f07462bf48a"></a><!-- doxytag: member="CommonToken::setLine" ref="a329f255e68b263713d564f07462bf48a" args="(int l)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CommonToken::setLine </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>l</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set line for token </p>
<p>Reimplemented from <a class="el" href="classToken.html#a6889656a11ef15dea59a31921d21a271">Token</a>.</p>
</div>
</div>
<a class="anchor" id="a173fd55a632bfd7c54479669de4bbac4"></a><!-- doxytag: member="CommonToken::setText" ref="a173fd55a632bfd7c54479669de4bbac4" args="(const std::string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CommonToken::setText </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set contents of token </p>
<p>Reimplemented from <a class="el" href="classToken.html#ac05b5927277234d3874b646dbf6d84d4">Token</a>.</p>
</div>
</div>
<a class="anchor" id="abd71ac0c79cb7adc17d5d0a2a4d83368"></a><!-- doxytag: member="CommonToken::toString" ref="abd71ac0c79cb7adc17d5d0a2a4d83368" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string CommonToken::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classToken.html#a773d56523f5d9f8c510cf8a6ed3543a0">Token</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a2a2d73eb8de862352a088737b1e07fe0"></a><!-- doxytag: member="CommonToken::col" ref="a2a2d73eb8de862352a088737b1e07fe0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classCommonToken.html#a2a2d73eb8de862352a088737b1e07fe0">CommonToken::col</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0d89014eedf28a833115301623666dfa"></a><!-- doxytag: member="CommonToken::line" ref="a0d89014eedf28a833115301623666dfa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classCommonToken.html#a0d89014eedf28a833115301623666dfa">CommonToken::line</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aad557464aad3d523859018dc1773d21c"></a><!-- doxytag: member="CommonToken::text" ref="aad557464aad3d523859018dc1773d21c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std ::string <a class="el" href="classCommonToken.html#aad557464aad3d523859018dc1773d21c">CommonToken::text</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="CommonToken_8hpp_source.html">CommonToken.hpp</a></li>
<li>src/<a class="el" href="CommonToken_8cpp.html">CommonToken.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>
