<!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/CircularQueue.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">CircularQueue.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="CircularQueue_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_CircularQueue_hpp__</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define INC_CircularQueue_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/CircularQueue.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 <vector></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <cassert></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span><a class="code" href="namespaceantlr.html">antlr</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// Resize every 5000 items</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="CircularQueue_8hpp.html#a2c874482105b2020baa78b12090c5eaa"> 21</a></span> <span class="preprocessor">#define OFFSET_MAX_RESIZE 5000</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classCircularQueue.html"> 24</a></span> <span class="keyword">class </span><a class="code" href="config_8hpp.html#ad583892c7af76867441115e41aa1ce52">ANTLR_API</a> <a class="code" href="classCircularQueue.html">CircularQueue</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classCircularQueue.html#afb497745b3a1e472ec670345328301a3"> 26</a></span>  <a class="code" href="classCircularQueue.html#afb497745b3a1e472ec670345328301a3">CircularQueue</a>()</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  : storage()</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  , m_offset(0)</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="l00031"></a><span class="lineno"><a class="line" href="classCircularQueue.html#ae983345f91859f4d532749f0b44531df"> 31</a></span>  <a class="code" href="classCircularQueue.html#ae983345f91859f4d532749f0b44531df">~CircularQueue</a>()</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</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> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classCircularQueue.html#ad7e561e9d933428f8192caeac1a08799"> 36</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classCircularQueue.html#ad7e561e9d933428f8192caeac1a08799">clear</a>( <span class="keywordtype">void</span> )</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  m_offset = 0;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  storage.clear();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</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="classCircularQueue.html#a15f47920c1263727fa4f63eab678726d"> 43</a></span>  <span class="keyword">inline</span> T <a class="code" href="classCircularQueue.html#a15f47920c1263727fa4f63eab678726d">elementAt</a>( <span class="keywordtype">size_t</span> idx )<span class="keyword"> const</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> storage[idx+m_offset];</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  }</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classCircularQueue.html#a6cb5b4274276ba1f68c57d7fe5aa4564"> 47</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCircularQueue.html#a6cb5b4274276ba1f68c57d7fe5aa4564">removeFirst</a>()</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">if</span> (m_offset >= <a class="code" href="CircularQueue_8hpp.html#a2c874482105b2020baa78b12090c5eaa">OFFSET_MAX_RESIZE</a>)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  storage.erase( storage.begin(), storage.begin() + m_offset + 1 );</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  m_offset = 0;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  ++m_offset;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classCircularQueue.html#a28c7ee9875555136b7fb9e45c62a1815"> 57</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classCircularQueue.html#a28c7ee9875555136b7fb9e45c62a1815">removeItems</a>( <span class="keywordtype">size_t</span> nb )</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// it would be nice if we would not get called with nb > entries</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// (or to be precise when entries() == 0)</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// This case is possible when lexer/parser::recover() calls</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// consume+consumeUntil when the queue is empty.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// In recover the consume says to prepare to read another</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// character/token. Then in the subsequent consumeUntil the</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// LA() call will trigger</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// syncConsume which calls this method *before* the same queue</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// has been sufficiently filled.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">if</span>( nb > entries() )</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  nb = entries();</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">if</span> (m_offset >= <a class="code" href="CircularQueue_8hpp.html#a2c874482105b2020baa78b12090c5eaa">OFFSET_MAX_RESIZE</a>)</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  storage.erase( storage.begin(), storage.begin() + m_offset + nb );</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  m_offset = 0;</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="keywordflow">else</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  m_offset += nb;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classCircularQueue.html#ae7f30d29129bd056a7117901c20be924"> 79</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classCircularQueue.html#ae7f30d29129bd056a7117901c20be924">append</a>(<span class="keyword">const</span> T& t)</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>  storage.push_back(t);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classCircularQueue.html#af6158137b4f16d231e50d64ed312ee48"> 83</a></span>  <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classCircularQueue.html#af6158137b4f16d231e50d64ed312ee48">entries</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">return</span> storage.size() - m_offset;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  }</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classCircularQueue.html#aef165383492ff44aa130d7c44e4885ab"> 89</a></span>  <a class="code" href="config_8hpp.html#ad1e4025d0db4046e6e85a46c92b7ff77">ANTLR_USE_NAMESPACE</a>(<a class="code" href="namespacestd.html">std</a>)vector<T> <a class="code" href="classCircularQueue.html#aef165383492ff44aa130d7c44e4885ab">storage</a>;</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="classCircularQueue.html#af8dc3a77badf84dae16a324d771afdee"> 90</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classCircularQueue.html#af8dc3a77badf84dae16a324d771afdee">m_offset</a>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classCircularQueue.html">CircularQueue</a>(<span class="keyword">const</span> <a class="code" href="classCircularQueue.html">CircularQueue</a>&);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> <a class="code" href="classCircularQueue.html">CircularQueue</a>& operator=(<span class="keyword">const</span> <a class="code" href="classCircularQueue.html">CircularQueue</a>&);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#ifdef ANTLR_CXX_SUPPORTS_NAMESPACE</span></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="preprocessor">#endif</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif //INC_CircularQueue_hpp__</span></div><div class="ttc" id="classCircularQueue_html_af6158137b4f16d231e50d64ed312ee48"><div class="ttname"><a href="classCircularQueue.html#af6158137b4f16d231e50d64ed312ee48">CircularQueue::entries</a></div><div class="ttdeci">size_t entries() const</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:83</div></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="CircularQueue_8hpp_html_a2c874482105b2020baa78b12090c5eaa"><div class="ttname"><a href="CircularQueue_8hpp.html#a2c874482105b2020baa78b12090c5eaa">OFFSET_MAX_RESIZE</a></div><div class="ttdeci">#define OFFSET_MAX_RESIZE</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:21</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="classCircularQueue_html_a15f47920c1263727fa4f63eab678726d"><div class="ttname"><a href="classCircularQueue.html#a15f47920c1263727fa4f63eab678726d">CircularQueue::elementAt</a></div><div class="ttdeci">T elementAt(size_t idx) const</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:43</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="Token_8hpp_html"><div class="ttname"><a href="Token_8hpp.html">Token.hpp</a></div></div>
<div class="ttc" id="classCircularQueue_html_ad7e561e9d933428f8192caeac1a08799"><div class="ttname"><a href="classCircularQueue.html#ad7e561e9d933428f8192caeac1a08799">CircularQueue::clear</a></div><div class="ttdeci">void clear(void)</div><div class="ttdoc">Clear the queue. </div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:36</div></div>
<div class="ttc" id="classCircularQueue_html_af8dc3a77badf84dae16a324d771afdee"><div class="ttname"><a href="classCircularQueue.html#af8dc3a77badf84dae16a324d771afdee">CircularQueue::m_offset</a></div><div class="ttdeci">size_t m_offset</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:90</div></div>
<div class="ttc" id="classCircularQueue_html_a28c7ee9875555136b7fb9e45c62a1815"><div class="ttname"><a href="classCircularQueue.html#a28c7ee9875555136b7fb9e45c62a1815">CircularQueue::removeItems</a></div><div class="ttdeci">void removeItems(size_t nb)</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:57</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="classCircularQueue_html_afb497745b3a1e472ec670345328301a3"><div class="ttname"><a href="classCircularQueue.html#afb497745b3a1e472ec670345328301a3">CircularQueue::CircularQueue</a></div><div class="ttdeci">CircularQueue()</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:26</div></div>
<div class="ttc" id="classCircularQueue_html_aef165383492ff44aa130d7c44e4885ab"><div class="ttname"><a href="classCircularQueue.html#aef165383492ff44aa130d7c44e4885ab">CircularQueue::storage</a></div><div class="ttdeci">std ::vector< T > storage</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:89</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="classCircularQueue_html_ae7f30d29129bd056a7117901c20be924"><div class="ttname"><a href="classCircularQueue.html#ae7f30d29129bd056a7117901c20be924">CircularQueue::append</a></div><div class="ttdeci">void append(const T &t)</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:79</div></div>
<div class="ttc" id="classCircularQueue_html_ae983345f91859f4d532749f0b44531df"><div class="ttname"><a href="classCircularQueue.html#ae983345f91859f4d532749f0b44531df">CircularQueue::~CircularQueue</a></div><div class="ttdeci">~CircularQueue()</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:31</div></div>
<div class="ttc" id="classCircularQueue_html_a6cb5b4274276ba1f68c57d7fe5aa4564"><div class="ttname"><a href="classCircularQueue.html#a6cb5b4274276ba1f68c57d7fe5aa4564">CircularQueue::removeFirst</a></div><div class="ttdeci">void removeFirst()</div><div class="ttdef"><b>Definition:</b> CircularQueue.hpp:47</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>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
da565b63a5fc04f7d71d08b821cb0a46
>
files
>
118
