<!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>libfilezilla: 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="projectlogo"><img alt="Logo" src="libfilezilla.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libfilezilla </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_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_bfd4f94fea6b65a4615f91ddf59adbf8.html">libfilezilla</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">uri.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="uri_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 LIBFILEZILLA_URI_HEADER</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define LIBFILEZILLA_URI_HEADER</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="preprocessor">#include "<a class="code" href="libfilezilla_8hpp.html">libfilezilla.hpp</a>"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <initializer_list></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <map></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span><a class="code" href="namespacefz.html">fz</a> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html"> 21</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1uri.html">uri</a> final</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">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="classfz_1_1uri.html">uri</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1uri.html">uri</a>(std::string <span class="keyword">const</span>& in);</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="keywordtype">void</span> clear();</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">bool</span> parse(std::string in);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  std::string <a class="code" href="namespacefz.html#aabb4fc6ca0cdc52ad2257ccd2108e0cf">to_string</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  std::string get_request() <span class="keyword">const</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  std::string get_authority(<span class="keywordtype">bool</span> with_userinfo) <span class="keyword">const</span>;</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>  <span class="keywordtype">bool</span> empty() <span class="keyword">const</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !empty(); }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#a6451f5ace019491e59f7af9372596000"> 55</a></span>  std::string <a class="code" href="classfz_1_1uri.html#a6451f5ace019491e59f7af9372596000">scheme_</a>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#a17442452651ea1479fa7d0e652f90810"> 58</a></span>  std::string <a class="code" href="classfz_1_1uri.html#a17442452651ea1479fa7d0e652f90810">user_</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#a3a78875daab87abdc63f1c10c4230525"> 61</a></span>  std::string <a class="code" href="classfz_1_1uri.html#a3a78875daab87abdc63f1c10c4230525">pass_</a>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#ada0f95acb51c9a574d38befa858d78fa"> 64</a></span>  std::string <a class="code" href="classfz_1_1uri.html#ada0f95acb51c9a574d38befa858d78fa">host_</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#a8dce0d727c65b03a54cea580c4ef62a4"> 67</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> port_{};</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#a679ba61b4152f83a46a4bb88b1cd7ca1"> 70</a></span>  std::string <a class="code" href="classfz_1_1uri.html#a679ba61b4152f83a46a4bb88b1cd7ca1">path_</a>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#a266ef43edf3a62f0bd8ab997feec04b3"> 79</a></span>  std::string <a class="code" href="classfz_1_1uri.html#a266ef43edf3a62f0bd8ab997feec04b3">query_</a>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#a748ce7bb525ba86cb28577310496392d"> 86</a></span>  std::string <a class="code" href="classfz_1_1uri.html#a748ce7bb525ba86cb28577310496392d">fragment_</a>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classfz_1_1uri.html#aac35171915c2bf3513531a89b7d2e091"> 89</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classfz_1_1uri.html#aac35171915c2bf3513531a89b7d2e091">is_absolute</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> path_[0] == <span class="charliteral">'/'</span>; }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> resolve(<a class="code" href="classfz_1_1uri.html">uri</a> <span class="keyword">const</span>& base);</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="keywordtype">bool</span> operator==(<a class="code" href="classfz_1_1uri.html">uri</a> <span class="keyword">const</span>& arg) <span class="keyword">const</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="keywordtype">bool</span> operator!=(<a class="code" href="classfz_1_1uri.html">uri</a> <span class="keyword">const</span>& arg)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !(*<span class="keyword">this</span> == arg); }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">bool</span> FZ_PRIVATE_SYMBOL parse_authority(std::string && authority);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> };</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="classfz_1_1query__string.html"> 111</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1query__string.html">query_string</a> final</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1query__string.html">query_string</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1query__string.html">query_string</a>(std::string <span class="keyword">const</span>& raw);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1query__string.html">query_string</a>(std::pair<std::string, std::string> <span class="keyword">const</span>& segment);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1query__string.html">query_string</a>(std::initializer_list<std::pair<std::string, std::string>> <span class="keyword">const</span>& segments);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">bool</span> set(std::string <span class="keyword">const</span>& raw);</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>  std::string <a class="code" href="namespacefz.html#aabb4fc6ca0cdc52ad2257ccd2108e0cf">to_string</a>(<span class="keywordtype">bool</span> encode_slashes) <span class="keyword">const</span>;</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>  <span class="keywordtype">void</span> remove(std::string <span class="keyword">const</span>& key);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  std::string& operator[](std::string <span class="keyword">const</span>& key);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  std::map<std::string, std::string, less_insensitive_ascii> <span class="keyword">const</span>& pairs()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> segments_; }</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">bool</span> empty()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> segments_.empty(); }</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  std::map<std::string, std::string, less_insensitive_ascii> segments_;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> };</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> }</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> <span class="preprocessor">#endif</span></div><div class="ttc" id="classfz_1_1uri_html"><div class="ttname"><a href="classfz_1_1uri.html">fz::uri</a></div><div class="ttdoc">The uri class is used to decompose URIs into their individual components.</div><div class="ttdef"><b>Definition:</b> uri.hpp:21</div></div> <div class="ttc" id="classfz_1_1uri_html_a266ef43edf3a62f0bd8ab997feec04b3"><div class="ttname"><a href="classfz_1_1uri.html#a266ef43edf3a62f0bd8ab997feec04b3">fz::uri::query_</a></div><div class="ttdeci">std::string query_</div><div class="ttdoc">The part of a URI after ? but before #.</div><div class="ttdef"><b>Definition:</b> uri.hpp:79</div></div> <div class="ttc" id="classfz_1_1uri_html_a17442452651ea1479fa7d0e652f90810"><div class="ttname"><a href="classfz_1_1uri.html#a17442452651ea1479fa7d0e652f90810">fz::uri::user_</a></div><div class="ttdeci">std::string user_</div><div class="ttdoc">Optional user part of the authority.</div><div class="ttdef"><b>Definition:</b> uri.hpp:58</div></div> <div class="ttc" id="classfz_1_1uri_html_a3a78875daab87abdc63f1c10c4230525"><div class="ttname"><a href="classfz_1_1uri.html#a3a78875daab87abdc63f1c10c4230525">fz::uri::pass_</a></div><div class="ttdeci">std::string pass_</div><div class="ttdoc">Optional password part of the authority.</div><div class="ttdef"><b>Definition:</b> uri.hpp:61</div></div> <div class="ttc" id="classfz_1_1uri_html_a6451f5ace019491e59f7af9372596000"><div class="ttname"><a href="classfz_1_1uri.html#a6451f5ace019491e59f7af9372596000">fz::uri::scheme_</a></div><div class="ttdeci">std::string scheme_</div><div class="ttdoc">Often refered to as the protocol prefix, e.g. ftp://.</div><div class="ttdef"><b>Definition:</b> uri.hpp:55</div></div> <div class="ttc" id="classfz_1_1query__string_html"><div class="ttname"><a href="classfz_1_1query__string.html">fz::query_string</a></div><div class="ttdoc">Class for parsing a URI's query string.</div><div class="ttdef"><b>Definition:</b> uri.hpp:111</div></div> <div class="ttc" id="classfz_1_1uri_html_a748ce7bb525ba86cb28577310496392d"><div class="ttname"><a href="classfz_1_1uri.html#a748ce7bb525ba86cb28577310496392d">fz::uri::fragment_</a></div><div class="ttdeci">std::string fragment_</div><div class="ttdoc">The part of a URI after #.</div><div class="ttdef"><b>Definition:</b> uri.hpp:86</div></div> <div class="ttc" id="namespacefz_html"><div class="ttname"><a href="namespacefz.html">fz</a></div><div class="ttdoc">The namespace used by libfilezilla.</div><div class="ttdef"><b>Definition:</b> apply.hpp:17</div></div> <div class="ttc" id="classfz_1_1uri_html_ada0f95acb51c9a574d38befa858d78fa"><div class="ttname"><a href="classfz_1_1uri.html#ada0f95acb51c9a574d38befa858d78fa">fz::uri::host_</a></div><div class="ttdeci">std::string host_</div><div class="ttdoc">Hostname, or IP address literal.</div><div class="ttdef"><b>Definition:</b> uri.hpp:64</div></div> <div class="ttc" id="libfilezilla_8hpp_html"><div class="ttname"><a href="libfilezilla_8hpp.html">libfilezilla.hpp</a></div><div class="ttdoc">Sets some global macros and further includes string.hpp.</div></div> <div class="ttc" id="classfz_1_1uri_html_aac35171915c2bf3513531a89b7d2e091"><div class="ttname"><a href="classfz_1_1uri.html#aac35171915c2bf3513531a89b7d2e091">fz::uri::is_absolute</a></div><div class="ttdeci">bool is_absolute() const</div><div class="ttdoc">Checks that the URI is absolute, that is the path starting with a slash.</div><div class="ttdef"><b>Definition:</b> uri.hpp:89</div></div> <div class="ttc" id="classfz_1_1uri_html_a679ba61b4152f83a46a4bb88b1cd7ca1"><div class="ttname"><a href="classfz_1_1uri.html#a679ba61b4152f83a46a4bb88b1cd7ca1">fz::uri::path_</a></div><div class="ttdeci">std::string path_</div><div class="ttdoc">Optional path, must start with a slash if set.</div><div class="ttdef"><b>Definition:</b> uri.hpp:70</div></div> <div class="ttc" id="namespacefz_html_aabb4fc6ca0cdc52ad2257ccd2108e0cf"><div class="ttname"><a href="namespacefz.html#aabb4fc6ca0cdc52ad2257ccd2108e0cf">fz::to_string</a></div><div class="ttdeci">std::string to_string(std::wstring_view const &in)</div><div class="ttdoc">Converts from std::wstring into std::string in system encoding.</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>