<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ANTLR Support Libraries 2.7.1+: antlr/CommonToken.hpp Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ANTLR Support Libraries 2.7.1+ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_9c8e8911af73f67dde8725dfb433f447.html">antlr</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">CommonToken.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="CommonToken_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef INC_CommonToken_hpp__</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define INC_CommonToken_hpp__</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/* ANTLR Translator Generator</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Project led by Terence Parr at http://www.jGuru.com</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Software rights: http://www.antlr.org/license.html</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * $Id: //depot/code/org.antlr/release/antlr-2.7.7/lib/cpp/antlr/CommonToken.hpp#2 $</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <<a class="code" href="config_8hpp.html">antlr/config.hpp</a>></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <<a class="code" href="Token_8hpp.html">antlr/Token.hpp</a>></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespaceantlr.html">antlr</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classCommonToken.html"> 19</a></span> <span class="keyword">class </span><a class="code" href="config_8hpp.html#ad583892c7af76867441115e41aa1ce52">ANTLR_API</a> <a class="code" href="classCommonToken.html">CommonToken</a> : <span class="keyword">public</span> <a class="code" href="classToken.html">Token</a> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <a class="code" href="classCommonToken.html">CommonToken</a>();</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <a class="code" href="classCommonToken.html">CommonToken</a>(<span class="keywordtype">int</span> t, <span class="keyword">const</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(<a class="code" href="namespacestd.html">std</a>)<span class="keywordtype">string</span>& txt);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="classCommonToken.html">CommonToken</a>(<span class="keyword">const</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(<a class="code" href="namespacestd.html">std</a>)<span class="keywordtype">string</span>& s);</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classCommonToken.html#a35fa00a7cdcbb964d539bab81c334d8c"> 26</a></span>  <span class="keyword">virtual</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(<a class="code" href="namespacestd.html">std</a>)<span class="keywordtype">string</span> <a class="code" href="classCommonToken.html#a35fa00a7cdcbb964d539bab81c334d8c">getText</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">return</span> text;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  }</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classCommonToken.html#aabc51467e099bb4514f243a056d07c62"> 32</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCommonToken.html#aabc51467e099bb4514f243a056d07c62">setText</a>(<span class="keyword">const</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(<a class="code" href="namespacestd.html">std</a>)<span class="keywordtype">string</span>& s)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  text = s;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classCommonToken.html#aafda805a71dd39555f67059b838e090c"> 41</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCommonToken.html#aafda805a71dd39555f67059b838e090c">getLine</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> line;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classCommonToken.html#add02cddd617f4b00def4930688e8f678"> 49</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCommonToken.html#add02cddd617f4b00def4930688e8f678">getColumn</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> col;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classCommonToken.html#a329f255e68b263713d564f07462bf48a"> 55</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCommonToken.html#a329f255e68b263713d564f07462bf48a">setLine</a>(<span class="keywordtype">int</span> l)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  line = l;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classCommonToken.html#aee8c0028292030a49450cf9dfc4b6a53"> 60</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCommonToken.html#aee8c0028292030a49450cf9dfc4b6a53">setColumn</a>(<span class="keywordtype">int</span> c)</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  col = c;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(<a class="code" href="namespacestd.html">std</a>)<span class="keywordtype">string</span> toString() <span class="keyword">const</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">static</span> <a class="code" href="classTokenRefCount.html">RefToken</a> factory();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// most tokens will want line and text information</span></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classCommonToken.html#a0d89014eedf28a833115301623666dfa"> 70</a></span>  <span class="keywordtype">int</span> <a class="code" href="classCommonToken.html#a0d89014eedf28a833115301623666dfa">line</a>;</div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classCommonToken.html#a2a2d73eb8de862352a088737b1e07fe0"> 71</a></span>  <span class="keywordtype">int</span> <a class="code" href="classCommonToken.html#a2a2d73eb8de862352a088737b1e07fe0">col</a>;</div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classCommonToken.html#aad557464aad3d523859018dc1773d21c"> 72</a></span>  <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(<a class="code" href="namespacestd.html">std</a>)<span class="keywordtype">string</span> <a class="code" href="classCommonToken.html#aad557464aad3d523859018dc1773d21c">text</a>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classCommonToken.html">CommonToken</a>(<span class="keyword">const</span> <a class="code" href="classCommonToken.html">CommonToken</a>&);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">const</span> <a class="code" href="classCommonToken.html">CommonToken</a>& operator=(<span class="keyword">const</span> <a class="code" href="classCommonToken.html">CommonToken</a>&);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> };</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif //INC_CommonToken_hpp__</span></div><div class="ttc" id="namespaceantlr_html"><div class="ttname"><a href="namespaceantlr.html">antlr</a></div><div class="ttdef"><b>Definition:</b> ANTLRException.hpp:15</div></div> <div class="ttc" id="classTokenRefCount_html"><div class="ttname"><a href="classTokenRefCount.html">TokenRefCount</a></div><div class="ttdef"><b>Definition:</b> TokenRefCount.hpp:43</div></div> <div class="ttc" id="classCommonToken_html_aee8c0028292030a49450cf9dfc4b6a53"><div class="ttname"><a href="classCommonToken.html#aee8c0028292030a49450cf9dfc4b6a53">CommonToken::setColumn</a></div><div class="ttdeci">virtual void setColumn(int c)</div><div class="ttdoc">set column for token </div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:60</div></div> <div class="ttc" id="classCommonToken_html_aabc51467e099bb4514f243a056d07c62"><div class="ttname"><a href="classCommonToken.html#aabc51467e099bb4514f243a056d07c62">CommonToken::setText</a></div><div class="ttdeci">virtual void setText(const std ::string &s)</div><div class="ttdoc">set contents of token </div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:32</div></div> <div class="ttc" id="classCommonToken_html"><div class="ttname"><a href="classCommonToken.html">CommonToken</a></div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:19</div></div> <div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div></div> <div class="ttc" id="config_8hpp_html"><div class="ttname"><a href="config_8hpp.html">config.hpp</a></div></div> <div class="ttc" id="config_8hpp_html_ad583892c7af76867441115e41aa1ce52"><div class="ttname"><a href="config_8hpp.html#ad583892c7af76867441115e41aa1ce52">ANTLR_API</a></div><div class="ttdeci">#define ANTLR_API</div><div class="ttdef"><b>Definition:</b> config.hpp:22</div></div> <div class="ttc" id="classCommonToken_html_a35fa00a7cdcbb964d539bab81c334d8c"><div class="ttname"><a href="classCommonToken.html#a35fa00a7cdcbb964d539bab81c334d8c">CommonToken::getText</a></div><div class="ttdeci">virtual std ::string getText() const</div><div class="ttdoc">return contents of token </div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:26</div></div> <div class="ttc" id="Token_8hpp_html"><div class="ttname"><a href="Token_8hpp.html">Token.hpp</a></div></div> <div class="ttc" id="classCommonToken_html_a0d89014eedf28a833115301623666dfa"><div class="ttname"><a href="classCommonToken.html#a0d89014eedf28a833115301623666dfa">CommonToken::line</a></div><div class="ttdeci">int line</div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:70</div></div> <div class="ttc" id="classCommonToken_html_aafda805a71dd39555f67059b838e090c"><div class="ttname"><a href="classCommonToken.html#aafda805a71dd39555f67059b838e090c">CommonToken::getLine</a></div><div class="ttdeci">virtual int getLine() const</div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:41</div></div> <div class="ttc" id="classCommonToken_html_a2a2d73eb8de862352a088737b1e07fe0"><div class="ttname"><a href="classCommonToken.html#a2a2d73eb8de862352a088737b1e07fe0">CommonToken::col</a></div><div class="ttdeci">int col</div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:71</div></div> <div class="ttc" id="classCommonToken_html_add02cddd617f4b00def4930688e8f678"><div class="ttname"><a href="classCommonToken.html#add02cddd617f4b00def4930688e8f678">CommonToken::getColumn</a></div><div class="ttdeci">virtual int getColumn() const</div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:49</div></div> <div class="ttc" id="classCommonToken_html_aad557464aad3d523859018dc1773d21c"><div class="ttname"><a href="classCommonToken.html#aad557464aad3d523859018dc1773d21c">CommonToken::text</a></div><div class="ttdeci">std ::string text</div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:72</div></div> <div class="ttc" id="config_8hpp_html_ad1e4025d0db4046e6e85a46c92b7ff77"><div class="ttname"><a href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a></div><div class="ttdeci">#define ANTLR_USE_NAMESPACE(_x_)</div><div class="ttdef"><b>Definition:</b> config.hpp:18</div></div> <div class="ttc" id="classToken_html"><div class="ttname"><a href="classToken.html">Token</a></div><div class="ttdef"><b>Definition:</b> Token.hpp:24</div></div> <div class="ttc" id="classCommonToken_html_a329f255e68b263713d564f07462bf48a"><div class="ttname"><a href="classCommonToken.html#a329f255e68b263713d564f07462bf48a">CommonToken::setLine</a></div><div class="ttdeci">virtual void setLine(int l)</div><div class="ttdoc">set line for token </div><div class="ttdef"><b>Definition:</b> CommonToken.hpp:55</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>