<!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: encode.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">encode.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="encode_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_ENCODE_HEADER</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define LIBFILEZILLA_ENCODE_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 <string></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span><a class="code" href="namespacefz.html">fz</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">template</span><<span class="keyword">typename</span> Char></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="namespacefz.html#a5f0aaa9b005d78645111219b39d3ea44"> 24</a></span> <span class="keywordtype">int</span> <a class="code" href="namespacefz.html#a5f0aaa9b005d78645111219b39d3ea44">hex_char_to_int</a>(Char c)</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">if</span> (c >= <span class="charliteral">'a'</span> && c <= <span class="charliteral">'z'</span>) {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">return</span> c - <span class="charliteral">'a'</span> + 10;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  }</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">if</span> (c >= <span class="charliteral">'A'</span> && c <= <span class="charliteral">'Z'</span>) {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span> c - <span class="charliteral">'A'</span> + 10;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (c >= <span class="charliteral">'0'</span> && c <= <span class="charliteral">'9'</span>) {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">return</span> c - <span class="charliteral">'0'</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">return</span> -1;</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> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span><<span class="keyword">typename</span> OutString, <span class="keyword">typename</span> String></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> OutString hex_decode_impl(String <span class="keyword">const</span>& in)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  OutString ret;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span> (!(in.size() % 2)) {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  ret.reserve(in.size() / 2);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < in.size(); i += 2) {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">int</span> high = <a class="code" href="namespacefz.html#a5f0aaa9b005d78645111219b39d3ea44">hex_char_to_int</a>(in[i]);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">int</span> low = <a class="code" href="namespacefz.html#a5f0aaa9b005d78645111219b39d3ea44">hex_char_to_int</a>(in[i + 1]);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">if</span> (high == -1 || low == -1) {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> OutString();</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>  ret.push_back(static_cast<typename OutString::value_type>((high << 4) + low));</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">return</span> ret;</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> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">template</span><<span class="keyword">typename</span> OutString = std::vector<u<span class="keywordtype">int</span>8_t>></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> OutString hex_decode(std::string_view <span class="keyword">const</span>& in)</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="keywordflow">return</span> hex_decode_impl<OutString>(in);</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> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">template</span><<span class="keyword">typename</span> OutString = std::vector<u<span class="keywordtype">int</span>8_t>></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> OutString hex_decode(std::wstring_view <span class="keyword">const</span>& in)</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>  <span class="keywordflow">return</span> hex_decode_impl<OutString>(in);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">template</span><<span class="keyword">typename</span> Char = <span class="keywordtype">char</span>, <span class="keywordtype">bool</span> Lowercase = true></div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="namespacefz.html#a7cd52bee449cb17dbd6952d4217b4b4b"> 77</a></span> Char <a class="code" href="namespacefz.html#a7cd52bee449cb17dbd6952d4217b4b4b">int_to_hex_char</a>(<span class="keywordtype">int</span> d)</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">if</span> (d > 9) {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> static_cast<Char>((Lowercase ? <span class="charliteral">'a'</span> : <span class="charliteral">'A'</span>) + d - 10);</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">else</span> {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> static_cast<Char>(<span class="charliteral">'0'</span> + d);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</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> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">template</span><<span class="keyword">typename</span> String, <span class="keyword">typename</span> InString, <span class="keywordtype">bool</span> Lowercase = true></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> String hex_encode(InString <span class="keyword">const</span>& data)</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>  static_assert(<span class="keyword">sizeof</span>(<span class="keyword">typename</span> InString::value_type) == 1, <span class="stringliteral">"Input must be a container of 8 bit values"</span>);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  String ret;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  ret.reserve(data.size() * 2);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> <span class="keyword">const</span>& c : data) {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  ret.push_back(int_to_hex_char<typename String::value_type, Lowercase>(static_cast<unsigned char>(c) >> 4));</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  ret.push_back(int_to_hex_char<typename String::value_type, Lowercase>(static_cast<unsigned char>(c) & 0xf));</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</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="keywordflow">return</span> ret;</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> </div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="namespacefz.html#acef92760774f58e04aff46410db2261a"> 107</a></span> <span class="keyword">enum class</span> <a class="code" href="namespacefz.html#acef92760774f58e04aff46410db2261a">base64_type</a> {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  standard,</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  url</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> };</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> std::string FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#af1f723fab10f456befc1f8721197de62">base64_encode</a>(std::string_view <span class="keyword">const</span>& in, <a class="code" href="namespacefz.html#acef92760774f58e04aff46410db2261a">base64_type</a> type = base64_type::standard, <span class="keywordtype">bool</span> pad = <span class="keyword">true</span>);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> std::string FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#af1f723fab10f456befc1f8721197de62">base64_encode</a>(std::vector<uint8_t> <span class="keyword">const</span>& in, <a class="code" href="namespacefz.html#acef92760774f58e04aff46410db2261a">base64_type</a> type = base64_type::standard, <span class="keywordtype">bool</span> pad = <span class="keyword">true</span>);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> std::string FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#ac093add794c4cf4ae8f7ee2cca62255c">base64_decode</a>(std::string_view <span class="keyword">const</span>& in);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> std::string FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#aec806ac93540158d944a040100cfa3c4">percent_encode</a>(std::string_view <span class="keyword">const</span>& s, <span class="keywordtype">bool</span> keep_slashes = <span class="keyword">false</span>);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> std::string FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#aec806ac93540158d944a040100cfa3c4">percent_encode</a>(std::wstring_view <span class="keyword">const</span>& s, <span class="keywordtype">bool</span> keep_slashes = <span class="keyword">false</span>);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> std::wstring FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#a7b964bc07874672b829284120b13fc0c">percent_encode_w</a>(std::wstring_view <span class="keyword">const</span>& s, <span class="keywordtype">bool</span> keep_slashes = <span class="keyword">false</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> std::string FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#a43909bc7da088eb3c74c3e9430a45259">percent_decode</a>(std::string_view <span class="keyword">const</span>& s, <span class="keywordtype">bool</span> allow_embedded_null = <span class="keyword">false</span>);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </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> </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="namespacefz_html_af1f723fab10f456befc1f8721197de62"><div class="ttname"><a href="namespacefz.html#af1f723fab10f456befc1f8721197de62">fz::base64_encode</a></div><div class="ttdeci">std::string base64_encode(std::string_view const &in, base64_type type=base64_type::standard, bool pad=true)</div><div class="ttdoc">Encodes raw input string to base64.</div></div>
<div class="ttc" id="namespacefz_html_a7cd52bee449cb17dbd6952d4217b4b4b"><div class="ttname"><a href="namespacefz.html#a7cd52bee449cb17dbd6952d4217b4b4b">fz::int_to_hex_char</a></div><div class="ttdeci">Char int_to_hex_char(int d)</div><div class="ttdoc">Converts an integer to the corresponding lowercase hex digit.</div><div class="ttdef"><b>Definition:</b> encode.hpp:77</div></div>
<div class="ttc" id="namespacefz_html_acef92760774f58e04aff46410db2261a"><div class="ttname"><a href="namespacefz.html#acef92760774f58e04aff46410db2261a">fz::base64_type</a></div><div class="ttdeci">base64_type</div><div class="ttdoc">Alphabet variations for base64.</div><div class="ttdef"><b>Definition:</b> encode.hpp:107</div></div>
<div class="ttc" id="namespacefz_html_a5f0aaa9b005d78645111219b39d3ea44"><div class="ttname"><a href="namespacefz.html#a5f0aaa9b005d78645111219b39d3ea44">fz::hex_char_to_int</a></div><div class="ttdeci">int hex_char_to_int(Char c)</div><div class="ttdoc">Converts a hex digit to decimal int.</div><div class="ttdef"><b>Definition:</b> encode.hpp:24</div></div>
<div class="ttc" id="namespacefz_html_aec806ac93540158d944a040100cfa3c4"><div class="ttname"><a href="namespacefz.html#aec806ac93540158d944a040100cfa3c4">fz::percent_encode</a></div><div class="ttdeci">std::string percent_encode(std::string_view const &s, bool keep_slashes=false)</div><div class="ttdoc">Percent-enodes string.</div></div>
<div class="ttc" id="namespacefz_html_ac093add794c4cf4ae8f7ee2cca62255c"><div class="ttname"><a href="namespacefz.html#ac093add794c4cf4ae8f7ee2cca62255c">fz::base64_decode</a></div><div class="ttdeci">std::string base64_decode(std::string_view const &in)</div><div class="ttdoc">Decodes base64, ignores whitespace. Returns empty string on invalid input.</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="namespacefz_html_a43909bc7da088eb3c74c3e9430a45259"><div class="ttname"><a href="namespacefz.html#a43909bc7da088eb3c74c3e9430a45259">fz::percent_decode</a></div><div class="ttdeci">std::string percent_decode(std::string_view const &s, bool allow_embedded_null=false)</div><div class="ttdoc">Percent-decodes string.</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="namespacefz_html_a7b964bc07874672b829284120b13fc0c"><div class="ttname"><a href="namespacefz.html#a7b964bc07874672b829284120b13fc0c">fz::percent_encode_w</a></div><div class="ttdeci">std::wstring percent_encode_w(std::wstring_view const &s, bool keep_slashes=false)</div><div class="ttdoc">Percent-encodes wide-character. Non-ASCII characters are converted to UTF-8 befor they are encoded.</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>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
94774a05d4f99367afd97b8b4adf565d
>
files
>
261
