aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/buffer_8hpp_source.html
blob: 81c5b54a252597035ab4c6f14aba014c08dbf4df (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>winapi_common: include/winapi/buffer.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">winapi_common
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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><li class="navelem"><a class="el" href="dir_f1714771db42b7b5a0cd2ebe6e9736ed.html">winapi</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">buffer.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">// Copyright (c) 2020 Egor Tensin &lt;Egor.Tensin@gmail.com&gt;</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// This file is part of the &quot;winapi-common&quot; project.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// For details, see https://github.com/egor-tensin/winapi-common.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Distributed under the MIT License.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &lt;cstddef&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &lt;cstring&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &lt;initializer_list&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;sstream&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;stdexcept&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</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="keyword">namespace </span>winapi {</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classwinapi_1_1Buffer.html">   24</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwinapi_1_1Buffer.html">Buffer</a> : <span class="keyword">public</span> std::vector&lt;unsigned char&gt; {</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    <span class="keyword">typedef</span> std::vector&lt;unsigned char&gt; Parent;</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <a class="code" href="classwinapi_1_1Buffer.html">Buffer</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classwinapi_1_1Buffer.html#abb43686e0f2e5798bc7b2c0e47722458">   31</a></span>&#160;    <a class="code" href="classwinapi_1_1Buffer.html#abb43686e0f2e5798bc7b2c0e47722458">Buffer</a>(std::initializer_list&lt;unsigned char&gt; lst) : Parent{lst} {}</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classwinapi_1_1Buffer.html#a46241e1fd3443c383c3930329ca9e0dd">   34</a></span>&#160;    <span class="keyword">explicit</span> <a class="code" href="classwinapi_1_1Buffer.html#a46241e1fd3443c383c3930329ca9e0dd">Buffer</a>(Parent&amp;&amp; src) : Parent{std::move(src)} {}</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> CharT&gt;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classwinapi_1_1Buffer.html#aa3566a7ac7025a2f88abe116082b55a7">   38</a></span>&#160;    <span class="keyword">explicit</span> <a class="code" href="classwinapi_1_1Buffer.html#aa3566a7ac7025a2f88abe116082b55a7">Buffer</a>(<span class="keyword">const</span> std::basic_string&lt;CharT&gt;&amp; src) {</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;        <a class="code" href="classwinapi_1_1Buffer.html#a0b2fad438202fbcfd4946baf3f879f59">set</a>(src);</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    }</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"><a class="line" href="classwinapi_1_1Buffer.html#ab3649ebbd0cbc4b20d02b660a52be89c">   43</a></span>&#160;    <a class="code" href="classwinapi_1_1Buffer.html#ab3649ebbd0cbc4b20d02b660a52be89c">Buffer</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* src, std::size_t nb) { <a class="code" href="classwinapi_1_1Buffer.html#a0b2fad438202fbcfd4946baf3f879f59">set</a>(src, nb); }</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">template</span> &lt;<span class="keyword">typename</span> CharT&gt;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classwinapi_1_1Buffer.html#a0b2fad438202fbcfd4946baf3f879f59">   47</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classwinapi_1_1Buffer.html#a0b2fad438202fbcfd4946baf3f879f59">set</a>(<span class="keyword">const</span> std::basic_string&lt;CharT&gt;&amp; src) {</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;        <a class="code" href="classwinapi_1_1Buffer.html#a0b2fad438202fbcfd4946baf3f879f59">set</a>(src.c_str(), src.length() * <span class="keyword">sizeof</span>(std::basic_string&lt;CharT&gt;::char_type));</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    }</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"><a class="line" href="classwinapi_1_1Buffer.html#ab09aa9c5075579510da463b4148ee610">   52</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classwinapi_1_1Buffer.html#ab09aa9c5075579510da463b4148ee610">set</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* src, std::size_t nb) {</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        resize(nb);</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;        std::memcpy(data(), src, nb);</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    }</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"><a class="line" href="classwinapi_1_1Buffer.html#afd8abcecacbcc9fdb4e5825068ebf561">   58</a></span>&#160;    std::string <a class="code" href="classwinapi_1_1Buffer.html#afd8abcecacbcc9fdb4e5825068ebf561">as_utf8</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> c_str = <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">char</span>*<span class="keyword">&gt;</span>(data());</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> nb = size();</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> nch = nb;</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;        <span class="keywordflow">return</span> {c_str, nch};</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    }</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classwinapi_1_1Buffer.html#ac5ca93f1935f2259db0d68e1884897d5">   66</a></span>&#160;    std::wstring <a class="code" href="classwinapi_1_1Buffer.html#ac5ca93f1935f2259db0d68e1884897d5">as_utf16</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> c_str = <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">wchar_t</span>*<span class="keyword">&gt;</span>(data());</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> nb = size();</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        <span class="keywordflow">if</span> (nb % 2 != 0) {</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;            std::ostringstream oss;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;            oss &lt;&lt; <span class="stringliteral">&quot;Buffer size invalid at &quot;</span> &lt;&lt; nb &lt;&lt; <span class="stringliteral">&quot; bytes&quot;</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;            <span class="keywordflow">throw</span> std::runtime_error{oss.str()};</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        }</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> nch = nb / 2;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        <span class="keywordflow">return</span> {c_str, nch};</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    }</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classwinapi_1_1Buffer.html#a303645b281fb4f1a4d9e84f1d1370182">   79</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classwinapi_1_1Buffer.html#a303645b281fb4f1a4d9e84f1d1370182">add</a>(<span class="keyword">const</span> <a class="code" href="classwinapi_1_1Buffer.html">Buffer</a>&amp; src) {</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> nb = size();</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;        resize(nb + src.size());</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;        std::memcpy(data() + nb, src.data(), src.size());</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    }</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;};</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;} <span class="comment">// namespace winapi</span></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html"><div class="ttname"><a href="classwinapi_1_1Buffer.html">winapi::Buffer</a></div><div class="ttdoc">Binary data container.</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00024">buffer.hpp:24</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_a0b2fad438202fbcfd4946baf3f879f59"><div class="ttname"><a href="classwinapi_1_1Buffer.html#a0b2fad438202fbcfd4946baf3f879f59">winapi::Buffer::set</a></div><div class="ttdeci">void set(const std::basic_string&lt; CharT &gt; &amp;src)</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00047">buffer.hpp:47</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_a303645b281fb4f1a4d9e84f1d1370182"><div class="ttname"><a href="classwinapi_1_1Buffer.html#a303645b281fb4f1a4d9e84f1d1370182">winapi::Buffer::add</a></div><div class="ttdeci">void add(const Buffer &amp;src)</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00079">buffer.hpp:79</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_a46241e1fd3443c383c3930329ca9e0dd"><div class="ttname"><a href="classwinapi_1_1Buffer.html#a46241e1fd3443c383c3930329ca9e0dd">winapi::Buffer::Buffer</a></div><div class="ttdeci">Buffer(Parent &amp;&amp;src)</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00034">buffer.hpp:34</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_aa3566a7ac7025a2f88abe116082b55a7"><div class="ttname"><a href="classwinapi_1_1Buffer.html#aa3566a7ac7025a2f88abe116082b55a7">winapi::Buffer::Buffer</a></div><div class="ttdeci">Buffer(const std::basic_string&lt; CharT &gt; &amp;src)</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00038">buffer.hpp:38</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_ab09aa9c5075579510da463b4148ee610"><div class="ttname"><a href="classwinapi_1_1Buffer.html#ab09aa9c5075579510da463b4148ee610">winapi::Buffer::set</a></div><div class="ttdeci">void set(const void *src, std::size_t nb)</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00052">buffer.hpp:52</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_ab3649ebbd0cbc4b20d02b660a52be89c"><div class="ttname"><a href="classwinapi_1_1Buffer.html#ab3649ebbd0cbc4b20d02b660a52be89c">winapi::Buffer::Buffer</a></div><div class="ttdeci">Buffer(const void *src, std::size_t nb)</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00043">buffer.hpp:43</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_abb43686e0f2e5798bc7b2c0e47722458"><div class="ttname"><a href="classwinapi_1_1Buffer.html#abb43686e0f2e5798bc7b2c0e47722458">winapi::Buffer::Buffer</a></div><div class="ttdeci">Buffer(std::initializer_list&lt; unsigned char &gt; lst)</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00031">buffer.hpp:31</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_ac5ca93f1935f2259db0d68e1884897d5"><div class="ttname"><a href="classwinapi_1_1Buffer.html#ac5ca93f1935f2259db0d68e1884897d5">winapi::Buffer::as_utf16</a></div><div class="ttdeci">std::wstring as_utf16() const</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00066">buffer.hpp:66</a></div></div>
<div class="ttc" id="aclasswinapi_1_1Buffer_html_afd8abcecacbcc9fdb4e5825068ebf561"><div class="ttname"><a href="classwinapi_1_1Buffer.html#afd8abcecacbcc9fdb4e5825068ebf561">winapi::Buffer::as_utf8</a></div><div class="ttdeci">std::string as_utf8() const</div><div class="ttdef"><b>Definition:</b> <a href="buffer_8hpp_source.html#l00058">buffer.hpp:58</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>