remwharead/docs/search_8hpp_source.html

87 lines
14 KiB
HTML

<!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>remwharead: include/search.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">remwharead
&#160;<span id="projectnumber">0.9.1</span>
</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&amp;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&amp;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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">search.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* This file is part of remwharead.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright © 2019 tastytea &lt;tastytea@tastytea.de&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the Free Software Foundation, version 3.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * GNU General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef REMWHAREAD_SEARCH_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define REMWHAREAD_SEARCH_HPP</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;sqlite.hpp&quot;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;list&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span>remwharead</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">using</span> std::list;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">using</span> std::string;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">using</span> std::vector;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classremwharead_1_1Search.html"> 38</a></span>&#160;<span class="keyword">class </span><a class="code" href="classremwharead_1_1Search.html">Search</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;{</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classremwharead_1_1Search.html#a8c5f3d0f81a29aca4129571271834a78">Search</a>(list&lt;Database::entry&gt; entries);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; [[nodiscard]]</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; list&lt;Database::entry&gt; <a class="code" href="classremwharead_1_1Search.html#a26ed67b476fa163979bb0bdcd22f964f">search_tags</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;expression, <span class="keywordtype">bool</span> is_re)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; [[nodiscard]]</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; list&lt;Database::entry&gt; <a class="code" href="classremwharead_1_1Search.html#ac6e0245ff0032600f8ce7ea7be5ecc3d">search_all</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;expression, <span class="keywordtype">bool</span> is_re)</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="comment">// TODO(tastytea): Think of something more elegant.</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; [[nodiscard]]</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; list&lt;Database::entry&gt; <a class="code" href="classremwharead_1_1Search.html#aaaa3f34ff323093f1957ba5d9ecc3954">search_all_threaded</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;expression,</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">bool</span> is_re) <span class="keyword">const</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">const</span> list&lt;Database::entry&gt; _entries;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; [[nodiscard]]</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; vector&lt;vector&lt;string&gt;&gt; parse_expression(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;expression) <span class="keyword">const</span>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; [[nodiscard]]</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">inline</span> <span class="keywordtype">string</span> to_lowercase(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;str) <span class="keyword">const</span>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;};</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;} <span class="comment">// namespace remwharead</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="preprocessor">#endif // REMWHAREAD_SEARCH_HPP</span></div><div class="ttc" id="classremwharead_1_1Search_html_a26ed67b476fa163979bb0bdcd22f964f"><div class="ttname"><a href="classremwharead_1_1Search.html#a26ed67b476fa163979bb0bdcd22f964f">remwharead::Search::search_tags</a></div><div class="ttdeci">list&lt; Database::entry &gt; search_tags(const string &amp;expression, bool is_re) const</div><div class="ttdoc">Search in tags of database entries.</div><div class="ttdef"><b>Definition:</b> search.cpp:86</div></div>
<div class="ttc" id="classremwharead_1_1Search_html_ac6e0245ff0032600f8ce7ea7be5ecc3d"><div class="ttname"><a href="classremwharead_1_1Search.html#ac6e0245ff0032600f8ce7ea7be5ecc3d">remwharead::Search::search_all</a></div><div class="ttdeci">list&lt; Database::entry &gt; search_all(const string &amp;expression, bool is_re) const</div><div class="ttdoc">Search in full text of database entries.</div><div class="ttdef"><b>Definition:</b> search.cpp:128</div></div>
<div class="ttc" id="classremwharead_1_1Search_html"><div class="ttname"><a href="classremwharead_1_1Search.html">remwharead::Search</a></div><div class="ttdoc">Search in database entries.</div><div class="ttdef"><b>Definition:</b> search.hpp:38</div></div>
<div class="ttc" id="classremwharead_1_1Search_html_aaaa3f34ff323093f1957ba5d9ecc3954"><div class="ttname"><a href="classremwharead_1_1Search.html#aaaa3f34ff323093f1957ba5d9ecc3954">remwharead::Search::search_all_threaded</a></div><div class="ttdeci">list&lt; Database::entry &gt; search_all_threaded(const string &amp;expression, bool is_re) const</div><div class="ttdoc">Spawn threads of search_all(), if it seems sensible.</div><div class="ttdef"><b>Definition:</b> search.cpp:204</div></div>
<div class="ttc" id="classremwharead_1_1Search_html_a8c5f3d0f81a29aca4129571271834a78"><div class="ttname"><a href="classremwharead_1_1Search.html#a8c5f3d0f81a29aca4129571271834a78">remwharead::Search::Search</a></div><div class="ttdeci">Search(list&lt; Database::entry &gt; entries)</div><div class="ttdoc">Defines the entries to search.</div><div class="ttdef"><b>Definition:</b> search.cpp:36</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>