<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Orcus: /home/iurt/rpmbuild/BUILD/liborcus-0.14.1/include/orcus/detail/parser_token_buffer.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">Orcus </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8a492e9ce3a64cbb6bdd89913aef68bf.html">orcus</a></li><li class="navelem"><a class="el" href="dir_fbef5e16ea03edf1da9c730f5d0df68f.html">detail</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">parser_token_buffer.hpp</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * This Source Code Form is subject to the terms of the Mozilla Public</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * License, v. 2.0. If a copy of the MPL was not distributed with this</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> */</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef INCLUDED_ORCUS_DETAIL_THREAD_PARSER_TOKEN_BUFFER_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define INCLUDED_ORCUS_DETAIL_THREAD_PARSER_TOKEN_BUFFER_HPP</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 "orcus/exception.hpp"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <condition_variable></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="keyword">namespace </span>orcus { <span class="keyword">namespace </span>detail { <span class="keyword">namespace </span>thread {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">template</span><<span class="keyword">typename</span> _TokensT></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html"> 23</a></span> <span class="keyword">class </span><a class="code" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html">parser_token_buffer</a></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">typedef</span> _TokensT tokens_type;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">mutable</span> std::mutex m_mtx_tokens;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  std::condition_variable m_cv_tokens_empty;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  std::condition_variable m_cv_tokens_ready;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  tokens_type m_tokens; <span class="comment">// token buffer used to hand over tokens to the client.</span></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>  <span class="keywordtype">size_t</span> m_token_size_threshold;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> m_max_token_size;</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>  <span class="keywordtype">bool</span> m_parsing_progress;</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>  <span class="keywordtype">bool</span> tokens_empty()<span class="keyword"> const</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  std::lock_guard<std::mutex> lock(m_mtx_tokens);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">return</span> m_tokens.empty();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> wait_until_tokens_empty()</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  std::unique_lock<std::mutex> lock(m_mtx_tokens);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">while</span> (!m_tokens.empty())</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  m_cv_tokens_empty.wait(lock);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</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> <span class="keyword">public</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html">parser_token_buffer</a>(<span class="keywordtype">size_t</span> min_token_size, <span class="keywordtype">size_t</span> max_token_size) :</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  m_token_size_threshold(std::max<size_t>(min_token_size, 1)),</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  m_max_token_size(max_token_size),</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  m_parsing_progress(<span class="keyword">true</span>)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">if</span> (m_token_size_threshold > m_max_token_size)</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">throw</span> <a class="code" href="classorcus_1_1invalid__arg__error.html">invalid_arg_error</a>(</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="stringliteral">"initial token size threshold is already larger than the max token size."</span>);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a51d53aaed94c9e40840a45de4b7ac392"> 76</a></span>  <span class="keywordtype">void</span> <a class="code" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a51d53aaed94c9e40840a45de4b7ac392">check_and_notify</a>(tokens_type& parser_tokens)</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>  <span class="keywordflow">if</span> (parser_tokens.size() < m_token_size_threshold)</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// Still below the threshold.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span>;</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="keywordflow">if</span> (!tokens_empty())</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">if</span> (m_token_size_threshold < (m_max_token_size/2))</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// Double the threshold and continue to parse.</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  m_token_size_threshold *= 2;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// We cannot increase the threshold any more. Wait for the</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// client to finish.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  wait_until_tokens_empty();</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>  std::unique_lock<std::mutex> lock(m_mtx_tokens);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  m_tokens.swap(parser_tokens);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  lock.unlock();</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  m_cv_tokens_ready.notify_one();</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a376a031e38519fefc1d9bb416fe91858"> 110</a></span>  <span class="keywordtype">void</span> <a class="code" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a376a031e38519fefc1d9bb416fe91858">notify_and_finish</a>(tokens_type& parser_tokens)</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// Wait until the client tokens get used up.</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  wait_until_tokens_empty();</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>  std::lock_guard<std::mutex> lock(m_mtx_tokens);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  m_tokens.swap(parser_tokens);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  m_parsing_progress = <span class="keyword">false</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  m_cv_tokens_ready.notify_one();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a9caf71d80abe97efb90fdace515dcec9"> 133</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a9caf71d80abe97efb90fdace515dcec9">next_tokens</a>(tokens_type& <a class="code" href="classorcus_1_1tokens.html">tokens</a>)</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="classorcus_1_1tokens.html">tokens</a>.clear();</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment">// Wait until the parser passes a new set of tokens.</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  std::unique_lock<std::mutex> lock(m_mtx_tokens);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordflow">while</span> (m_tokens.empty() && m_parsing_progress)</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  m_cv_tokens_ready.wait(lock);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="comment">// Get the new tokens and notify the parser.</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <a class="code" href="classorcus_1_1tokens.html">tokens</a>.swap(m_tokens);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">bool</span> parsing_progress = m_parsing_progress; <span class="comment">// Make a copy so that lock can be released safely.</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  lock.unlock();</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  m_cv_tokens_empty.notify_one();</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">return</span> parsing_progress;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  }</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00159"></a><span class="lineno"><a class="line" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a8911feeec9a824afd91ad5039394d9c0"> 159</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a8911feeec9a824afd91ad5039394d9c0">token_size_threshold</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordflow">if</span> (m_parsing_progress)</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordflow">return</span> m_token_size_threshold;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  }</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> };</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> }}}</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">/* vim:set shiftwidth=4 softtabstop=4 expandtab: */</span></div><div class="ttc" id="classorcus_1_1detail_1_1thread_1_1parser__token__buffer_html"><div class="ttname"><a href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html">orcus::detail::thread::parser_token_buffer</a></div><div class="ttdef"><b>Definition:</b> parser_token_buffer.hpp:23</div></div> <div class="ttc" id="classorcus_1_1detail_1_1thread_1_1parser__token__buffer_html_a51d53aaed94c9e40840a45de4b7ac392"><div class="ttname"><a href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a51d53aaed94c9e40840a45de4b7ac392">orcus::detail::thread::parser_token_buffer::check_and_notify</a></div><div class="ttdeci">void check_and_notify(tokens_type &parser_tokens)</div><div class="ttdef"><b>Definition:</b> parser_token_buffer.hpp:76</div></div> <div class="ttc" id="classorcus_1_1detail_1_1thread_1_1parser__token__buffer_html_a8911feeec9a824afd91ad5039394d9c0"><div class="ttname"><a href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a8911feeec9a824afd91ad5039394d9c0">orcus::detail::thread::parser_token_buffer::token_size_threshold</a></div><div class="ttdeci">size_t token_size_threshold() const</div><div class="ttdef"><b>Definition:</b> parser_token_buffer.hpp:159</div></div> <div class="ttc" id="classorcus_1_1tokens_html"><div class="ttname"><a href="classorcus_1_1tokens.html">orcus::tokens</a></div><div class="ttdef"><b>Definition:</b> tokens.hpp:21</div></div> <div class="ttc" id="classorcus_1_1invalid__arg__error_html"><div class="ttname"><a href="classorcus_1_1invalid__arg__error.html">orcus::invalid_arg_error</a></div><div class="ttdef"><b>Definition:</b> exception.hpp:29</div></div> <div class="ttc" id="classorcus_1_1detail_1_1thread_1_1parser__token__buffer_html_a376a031e38519fefc1d9bb416fe91858"><div class="ttname"><a href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a376a031e38519fefc1d9bb416fe91858">orcus::detail::thread::parser_token_buffer::notify_and_finish</a></div><div class="ttdeci">void notify_and_finish(tokens_type &parser_tokens)</div><div class="ttdef"><b>Definition:</b> parser_token_buffer.hpp:110</div></div> <div class="ttc" id="classorcus_1_1detail_1_1thread_1_1parser__token__buffer_html_a9caf71d80abe97efb90fdace515dcec9"><div class="ttname"><a href="classorcus_1_1detail_1_1thread_1_1parser__token__buffer.html#a9caf71d80abe97efb90fdace515dcec9">orcus::detail::thread::parser_token_buffer::next_tokens</a></div><div class="ttdeci">bool next_tokens(tokens_type &tokens)</div><div class="ttdef"><b>Definition:</b> parser_token_buffer.hpp:133</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Jan 11 2019 05:05:17 for Orcus by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>