95 lines
20 KiB
HTML
95 lines
20 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/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
|
|
 <span id="projectnumber">0.8.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&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> </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> <span class="comment">/* This file is part of remwharead.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright © 2019 tastytea <tastytea@tastytea.de></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <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> <span class="comment"> * the Free Software Foundation, version 3.</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"> * 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> <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> <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> <span class="comment"> * GNU General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <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> <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef REMWHAREAD_URI_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define REMWHAREAD_URI_HPP</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="preprocessor">#include <string></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>remwharead</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structremwharead_1_1html__extract.html"> 35</a></span>  <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="l00036"></a><span class="lineno"> 36</span>  {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">bool</span> successful = <span class="keyword">false</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">string</span> error;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">string</span> title;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">string</span> description;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">string</span> fulltext;</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>  <span class="keyword">operator</span> bool();</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  } <a class="code" href="structremwharead_1_1html__extract.html">html_extract</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structremwharead_1_1archive__answer.html"> 55</a></span>  <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structremwharead_1_1archive__answer.html">archive_answer</a></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="keywordtype">bool</span> successful = <span class="keyword">false</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">string</span> error;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">string</span> uri;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">operator</span> bool();</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  } <a class="code" href="structremwharead_1_1archive__answer.html">archive_answer</a>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classremwharead_1_1URI.html"> 71</a></span>  <span class="keyword">class </span><a class="code" href="classremwharead_1_1URI.html">URI</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>  <span class="keyword">public</span>:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <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> &uri);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> ~<a class="code" href="classremwharead_1_1URI.html">URI</a>();</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">const</span> <a class="code" href="structremwharead_1_1html__extract.html">html_extract</a> <a class="code" href="classremwharead_1_1URI.html#a8d6ac084a823749ed38c12e7bf8f3461">get</a>();</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">const</span> <a class="code" href="structremwharead_1_1archive__answer.html">archive_answer</a> <a class="code" href="classremwharead_1_1URI.html#a4252486ed37ea89083b87dbdb0763e45">archive</a>();</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">string</span> _uri;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a9f4e1777bfbff72f098d7e1a7623a3c5">make_request</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &uri,</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">bool</span> <a class="code" href="classremwharead_1_1URI.html#a4252486ed37ea89083b87dbdb0763e45">archive</a> = <span class="keyword">false</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <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> &html);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <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> &html);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <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> &html);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <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> &html,</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> &tag = <span class="stringliteral">""</span>);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#ac98523e5fb23ca4adab57a7caa473eaa">unescape_html</a>(<span class="keywordtype">string</span> html);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <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="l00155"></a><span class="lineno"> 155</span>  };</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> }</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#endif // REMWHAREAD_URI_HPP</span></div><div class="ttc" id="classremwharead_1_1URI_html_ac98523e5fb23ca4adab57a7caa473eaa"><div class="ttname"><a href="classremwharead_1_1URI.html#ac98523e5fb23ca4adab57a7caa473eaa">remwharead::URI::unescape_html</a></div><div class="ttdeci">const string unescape_html(string html)</div><div class="ttdoc">Convert HTML entities to UTF-8.</div><div class="ttdef"><b>Definition:</b> uri.cpp:298</div></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:35</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 &uri)</div><div class="ttdoc">Construct object and set URL.</div><div class="ttdef"><b>Definition:</b> uri.cpp:62</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 &html, const string &tag="")</div><div class="ttdoc">Remove HTML tags.</div><div class="ttdef"><b>Definition:</b> uri.cpp:260</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 &html)</div><div class="ttdoc">Removes HTML tags and superflous spaces from an HTML page.</div><div class="ttdef"><b>Definition:</b> uri.cpp:239</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:623</div></div>
|
|
<div class="ttc" id="structremwharead_1_1archive__answer_html"><div class="ttname"><a href="structremwharead_1_1archive__answer.html">remwharead::archive_answer</a></div><div class="ttdoc">The result of the call to the archive service.</div><div class="ttdef"><b>Definition:</b> uri.hpp:55</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a8d6ac084a823749ed38c12e7bf8f3461"><div class="ttname"><a href="classremwharead_1_1URI.html#a8d6ac084a823749ed38c12e7bf8f3461">remwharead::URI::get</a></div><div class="ttdeci">const html_extract get()</div><div class="ttdoc">Download URI and extract title, description and full text.</div><div class="ttdef"><b>Definition:</b> uri.cpp:106</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 &html)</div><div class="ttdoc">Extract the title from an HTML page.</div><div class="ttdef"><b>Definition:</b> uri.cpp:204</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:71</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a9f4e1777bfbff72f098d7e1a7623a3c5"><div class="ttname"><a href="classremwharead_1_1URI.html#a9f4e1777bfbff72f098d7e1a7623a3c5">remwharead::URI::make_request</a></div><div class="ttdeci">const string make_request(const string &uri, bool archive=false) const</div><div class="ttdoc">Make a HTTP(S) request.</div><div class="ttdef"><b>Definition:</b> uri.cpp:131</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a4252486ed37ea89083b87dbdb0763e45"><div class="ttname"><a href="classremwharead_1_1URI.html#a4252486ed37ea89083b87dbdb0763e45">remwharead::URI::archive</a></div><div class="ttdeci">const archive_answer archive()</div><div class="ttdoc">Save URI in archive and return archive-URI.</div><div class="ttdef"><b>Definition:</b> uri.cpp:598</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 &html)</div><div class="ttdoc">Extract the description from an HTML page.</div><div class="ttdef"><b>Definition:</b> uri.cpp:221</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.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|