<!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/TokenBuffer.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">TokenBuffer.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="TokenBuffer_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_TokenBuffer_hpp__</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define INC_TokenBuffer_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/TokenBuffer.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="TokenStream_8hpp.html">antlr/TokenStream.hpp</a>></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <<a class="code" href="CircularQueue_8hpp.html">antlr/CircularQueue.hpp</a>></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="l00036"></a><span class="lineno"><a class="line" href="classTokenBuffer.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="config_8hpp.html#ad583892c7af76867441115e41aa1ce52">ANTLR_API</a> <a class="code" href="classTokenBuffer.html">TokenBuffer</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classTokenBuffer.html">TokenBuffer</a>(<a class="code" href="classTokenStream.html">TokenStream</a>& input_);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> ~<a class="code" href="classTokenBuffer.html">TokenBuffer</a>();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classTokenBuffer.html#a9eac55ad444531a34a6de112b3e966e2"> 43</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classTokenBuffer.html#a9eac55ad444531a34a6de112b3e966e2">reset</a>( <span class="keywordtype">void</span> )</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  nMarkers = 0;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  markerOffset = 0;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  numToConsume = 0;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  queue.clear();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">int</span> LA( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i );</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classTokenRefCount.html">RefToken</a> LT( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i );</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mark();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> rewind(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mark);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classTokenBuffer.html#a1608b77ba5671fe96428523620e62a33"> 68</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classTokenBuffer.html#a1608b77ba5671fe96428523620e62a33">consume</a>()</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  numToConsume++;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> entries() <span class="keyword">const</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> fill(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> amount);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> syncConsume();</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classTokenBuffer.html#ab64546a189551b2bfdb7d44ce9f10613"> 84</a></span>  <a class="code" href="classTokenStream.html">TokenStream</a>& <a class="code" href="classTokenBuffer.html#ab64546a189551b2bfdb7d44ce9f10613">input</a>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classTokenBuffer.html#abf3c969f4554b377d07cb328b5a3e6df"> 87</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classTokenBuffer.html#abf3c969f4554b377d07cb328b5a3e6df">nMarkers</a>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classTokenBuffer.html#aa2348bea0cea1ee61abe87ded1794685"> 90</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classTokenBuffer.html#aa2348bea0cea1ee61abe87ded1794685">markerOffset</a>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classTokenBuffer.html#ae2ec979dbe4ef1a39f65d7142bc333ca"> 93</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classTokenBuffer.html#ae2ec979dbe4ef1a39f65d7142bc333ca">numToConsume</a>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classTokenBuffer.html#acd4cf4d1b81f1e1a2479da306788121e"> 96</a></span>  <a class="code" href="classCircularQueue.html">CircularQueue<RefToken></a> <a class="code" href="classTokenBuffer.html#acd4cf4d1b81f1e1a2479da306788121e">queue</a>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classTokenBuffer.html">TokenBuffer</a>(<span class="keyword">const</span> <a class="code" href="classTokenBuffer.html">TokenBuffer</a>& other);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">const</span> <a class="code" href="classTokenBuffer.html">TokenBuffer</a>& operator=(<span class="keyword">const</span> <a class="code" href="classTokenBuffer.html">TokenBuffer</a>& other);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> };</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classTokenBuffer.html#a9427fa1eeaa8beedcd63b156d283b969"> 104</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classTokenBuffer.html#a9427fa1eeaa8beedcd63b156d283b969">TokenBuffer::syncConsume</a>()</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">if</span> (numToConsume > 0)</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">if</span> (nMarkers > 0)</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  markerOffset += numToConsume;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  queue.removeItems( numToConsume );</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  numToConsume = 0;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  }</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#endif //INC_TokenBuffer_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="classTokenBuffer_html_ae2ec979dbe4ef1a39f65d7142bc333ca"><div class="ttname"><a href="classTokenBuffer.html#ae2ec979dbe4ef1a39f65d7142bc333ca">TokenBuffer::numToConsume</a></div><div class="ttdeci">unsigned int numToConsume</div><div class="ttdoc">Number of calls to consume() since last LA() or LT() call. </div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:93</div></div> <div class="ttc" id="classTokenBuffer_html_abf3c969f4554b377d07cb328b5a3e6df"><div class="ttname"><a href="classTokenBuffer.html#abf3c969f4554b377d07cb328b5a3e6df">TokenBuffer::nMarkers</a></div><div class="ttdeci">unsigned int nMarkers</div><div class="ttdoc">Number of active markers. </div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:87</div></div> <div class="ttc" id="classTokenBuffer_html_aa2348bea0cea1ee61abe87ded1794685"><div class="ttname"><a href="classTokenBuffer.html#aa2348bea0cea1ee61abe87ded1794685">TokenBuffer::markerOffset</a></div><div class="ttdeci">unsigned int markerOffset</div><div class="ttdoc">Additional offset used when markers are active. </div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:90</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="classTokenBuffer_html_ab64546a189551b2bfdb7d44ce9f10613"><div class="ttname"><a href="classTokenBuffer.html#ab64546a189551b2bfdb7d44ce9f10613">TokenBuffer::input</a></div><div class="ttdeci">TokenStream & input</div><div class="ttdoc">Token source. </div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:84</div></div> <div class="ttc" id="classTokenBuffer_html"><div class="ttname"><a href="classTokenBuffer.html">TokenBuffer</a></div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:36</div></div> <div class="ttc" id="classTokenBuffer_html_a9427fa1eeaa8beedcd63b156d283b969"><div class="ttname"><a href="classTokenBuffer.html#a9427fa1eeaa8beedcd63b156d283b969">TokenBuffer::syncConsume</a></div><div class="ttdeci">void syncConsume()</div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:104</div></div> <div class="ttc" id="classTokenBuffer_html_acd4cf4d1b81f1e1a2479da306788121e"><div class="ttname"><a href="classTokenBuffer.html#acd4cf4d1b81f1e1a2479da306788121e">TokenBuffer::queue</a></div><div class="ttdeci">CircularQueue< RefToken > queue</div><div class="ttdoc">Circular queue with Tokens. </div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:96</div></div> <div class="ttc" id="classTokenBuffer_html_a1608b77ba5671fe96428523620e62a33"><div class="ttname"><a href="classTokenBuffer.html#a1608b77ba5671fe96428523620e62a33">TokenBuffer::consume</a></div><div class="ttdeci">void consume()</div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:68</div></div> <div class="ttc" id="classTokenStream_html"><div class="ttname"><a href="classTokenStream.html">TokenStream</a></div><div class="ttdef"><b>Definition:</b> TokenStream.hpp:22</div></div> <div class="ttc" id="CircularQueue_8hpp_html"><div class="ttname"><a href="CircularQueue_8hpp.html">CircularQueue.hpp</a></div></div> <div class="ttc" id="classCircularQueue_html"><div class="ttname"><a href="classCircularQueue.html">CircularQueue</a></div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:24</div></div> <div class="ttc" id="TokenStream_8hpp_html"><div class="ttname"><a href="TokenStream_8hpp.html">TokenStream.hpp</a></div></div> <div class="ttc" id="classTokenBuffer_html_a9eac55ad444531a34a6de112b3e966e2"><div class="ttname"><a href="classTokenBuffer.html#a9eac55ad444531a34a6de112b3e966e2">TokenBuffer::reset</a></div><div class="ttdeci">void reset(void)</div><div class="ttdoc">Reset the input buffer to empty state. </div><div class="ttdef"><b>Definition:</b> TokenBuffer.hpp:43</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>