remwharead/docs/uri_8hpp_source.html

94 lines
17 KiB
HTML

<!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>remwharead: src/lib/uri.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.6.3</span>
</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&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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c85d3e3c5052e9ad9ce18c6863244a25.html">lib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">uri.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_URI_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define REMWHAREAD_URI_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 &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;curlpp/Easy.hpp&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceremwharead.html">remwharead</a></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">using</span> std::string;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structremwharead_1_1html__extract.html"> 28</a></span>&#160; <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structremwharead_1_1html__extract.html">html_extract</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">string</span> title;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">string</span> description;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">string</span> fulltext;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; } <a class="code" href="structremwharead_1_1html__extract.html">html_extract</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classremwharead_1_1URI.html"> 36</a></span>&#160; <span class="keyword">class </span><a class="code" href="classremwharead_1_1URI.html">URI</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classremwharead_1_1URI.html#acda508768b1fd3b4df81ea66dd4fab87">URI</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;uri);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">const</span> <a class="code" href="structremwharead_1_1html__extract.html">html_extract</a> <span class="keyword">get</span>();</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a074b3aa3ec7658b184869599c9ab6445">archive</a>();</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">string</span> _uri;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classremwharead_1_1URI.html#a203f46af6271ecd5a1ff01c63461d842">set_curlpp_options</a>(curlpp::Easy &amp;request);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a37f93c46371d9b3753ae04bd2ef2c362">extract_title</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;html);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#ae6ff7a41b9529eb8f4c7f2ace7260dc7">extract_description</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;html);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#ad6ad5351ecf2983e01f9f4a51c2057a5">strip_html</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;html);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a8b340b13ccf0bc3ae9059872ce48e06a">remove_html_tags</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;html,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;tag = <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a37c36dbf8ccc03c8cc132be29e49f4ec">unescape_html</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;html);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a9373cb28de198ae2db624980273ece4a">remove_newlines</a>(<span class="keywordtype">string</span> text);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; };</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;}</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#endif // REMWHAREAD_URI_HPP</span></div><div class="ttc" id="structremwharead_1_1html__extract_html"><div class="ttname"><a href="structremwharead_1_1html__extract.html">remwharead::html_extract</a></div><div class="ttdoc">A processed HTML page. </div><div class="ttdef"><b>Definition:</b> uri.hpp:28</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_acda508768b1fd3b4df81ea66dd4fab87"><div class="ttname"><a href="classremwharead_1_1URI.html#acda508768b1fd3b4df81ea66dd4fab87">remwharead::URI::URI</a></div><div class="ttdeci">URI(const string &amp;uri)</div><div class="ttdoc">Construct object and set URL. </div><div class="ttdef"><b>Definition:</b> uri.cpp:43</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_a8b340b13ccf0bc3ae9059872ce48e06a"><div class="ttname"><a href="classremwharead_1_1URI.html#a8b340b13ccf0bc3ae9059872ce48e06a">remwharead::URI::remove_html_tags</a></div><div class="ttdeci">const string remove_html_tags(const string &amp;html, const string &amp;tag=&quot;&quot;)</div><div class="ttdoc">Remove HTML tags. </div><div class="ttdef"><b>Definition:</b> uri.cpp:137</div></div>
<div class="ttc" id="namespaceremwharead_html"><div class="ttname"><a href="namespaceremwharead.html">remwharead</a></div><div class="ttdef"><b>Definition:</b> search.cpp:23</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_ad6ad5351ecf2983e01f9f4a51c2057a5"><div class="ttname"><a href="classremwharead_1_1URI.html#ad6ad5351ecf2983e01f9f4a51c2057a5">remwharead::URI::strip_html</a></div><div class="ttdeci">const string strip_html(const string &amp;html)</div><div class="ttdoc">Removes HTML tags and superflous spaces from an HTML page. </div><div class="ttdef"><b>Definition:</b> uri.cpp:118</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_a9373cb28de198ae2db624980273ece4a"><div class="ttname"><a href="classremwharead_1_1URI.html#a9373cb28de198ae2db624980273ece4a">remwharead::URI::remove_newlines</a></div><div class="ttdeci">const string remove_newlines(string text)</div><div class="ttdoc">Replace newlines with spaces. </div><div class="ttdef"><b>Definition:</b> uri.cpp:514</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_a37c36dbf8ccc03c8cc132be29e49f4ec"><div class="ttname"><a href="classremwharead_1_1URI.html#a37c36dbf8ccc03c8cc132be29e49f4ec">remwharead::URI::unescape_html</a></div><div class="ttdeci">const string unescape_html(const string &amp;html)</div><div class="ttdoc">Convert HTML entities to UTF-8. </div><div class="ttdef"><b>Definition:</b> uri.cpp:175</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_a203f46af6271ecd5a1ff01c63461d842"><div class="ttname"><a href="classremwharead_1_1URI.html#a203f46af6271ecd5a1ff01c63461d842">remwharead::URI::set_curlpp_options</a></div><div class="ttdeci">void set_curlpp_options(curlpp::Easy &amp;request)</div><div class="ttdoc">Sets common curlpp options. </div><div class="ttdef"><b>Definition:</b> uri.cpp:83</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_a37f93c46371d9b3753ae04bd2ef2c362"><div class="ttname"><a href="classremwharead_1_1URI.html#a37f93c46371d9b3753ae04bd2ef2c362">remwharead::URI::extract_title</a></div><div class="ttdeci">const string extract_title(const string &amp;html)</div><div class="ttdoc">Extract the title from an HTML page. </div><div class="ttdef"><b>Definition:</b> uri.cpp:91</div></div>
<div class="ttc" id="classremwharead_1_1URI_html"><div class="ttname"><a href="classremwharead_1_1URI.html">remwharead::URI</a></div><div class="ttdoc">Download, archive and process an URI. </div><div class="ttdef"><b>Definition:</b> uri.hpp:36</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_a074b3aa3ec7658b184869599c9ab6445"><div class="ttname"><a href="classremwharead_1_1URI.html#a074b3aa3ec7658b184869599c9ab6445">remwharead::URI::archive</a></div><div class="ttdeci">const string archive()</div><div class="ttdoc">Save URI in archive and return archive-URI. </div><div class="ttdef"><b>Definition:</b> uri.cpp:475</div></div>
<div class="ttc" id="classremwharead_1_1URI_html_ae6ff7a41b9529eb8f4c7f2ace7260dc7"><div class="ttname"><a href="classremwharead_1_1URI.html#ae6ff7a41b9529eb8f4c7f2ace7260dc7">remwharead::URI::extract_description</a></div><div class="ttdeci">const string extract_description(const string &amp;html)</div><div class="ttdoc">Extract the description from an HTML page. </div><div class="ttdef"><b>Definition:</b> uri.cpp:104</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.14
</small></address>
</body>
</html>