-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathclassfly_1_1_bit_stream_writer.html
321 lines (308 loc) · 18.5 KB
/
classfly_1_1_bit_stream_writer.html
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<!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>libfly: fly::BitStreamWriter Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.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">libfly
 <span id="projectnumber">6.2.2</span>
</div>
<div id="projectbrief">C++20 utility library for Linux, macOS, and Windows</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&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&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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classfly_1_1_bit_stream_writer.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classfly_1_1_bit_stream_writer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fly::BitStreamWriter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="bit__stream__writer_8hpp_source.html">bit_stream_writer.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for fly::BitStreamWriter:</div>
<div class="dyncontent">
<div class="center"><img src="classfly_1_1_bit_stream_writer__inherit__graph.png" border="0" usemap="#afly_1_1_bit_stream_writer_inherit__map" alt="Inheritance graph"/></div>
<map name="afly_1_1_bit_stream_writer_inherit__map" id="afly_1_1_bit_stream_writer_inherit__map">
<area shape="rect" title=" " alt="" coords="7,80,158,107"/>
<area shape="rect" href="classfly_1_1detail_1_1_bit_stream.html" title=" " alt="" coords="5,5,160,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for fly::BitStreamWriter:</div>
<div class="dyncontent">
<div class="center"><img src="classfly_1_1_bit_stream_writer__coll__graph.png" border="0" usemap="#afly_1_1_bit_stream_writer_coll__map" alt="Collaboration graph"/></div>
<map name="afly_1_1_bit_stream_writer_coll__map" id="afly_1_1_bit_stream_writer_coll__map">
<area shape="rect" title=" " alt="" coords="7,80,158,107"/>
<area shape="rect" href="classfly_1_1detail_1_1_bit_stream.html" title=" " alt="" coords="5,5,160,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aac978a668121bd958d340f6f3d567ccf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfly_1_1_bit_stream_writer.html#aac978a668121bd958d340f6f3d567ccf">BitStreamWriter</a> (std::ostream &stream) noexcept</td></tr>
<tr class="separator:aac978a668121bd958d340f6f3d567ccf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f28589dc377c9d8110cd86d82e249a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfly_1_1_bit_stream_writer.html#a8f28589dc377c9d8110cd86d82e249a6">write_word</a> (word_type word)</td></tr>
<tr class="separator:a8f28589dc377c9d8110cd86d82e249a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c1d23024a1c07b13e32b78c52491367"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfly_1_1_bit_stream_writer.html#a4c1d23024a1c07b13e32b78c52491367">write_byte</a> (byte_type byte)</td></tr>
<tr class="separator:a4c1d23024a1c07b13e32b78c52491367"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8adc929ff06cf2c95d7d0a2e74b83b40"><td class="memTemplParams" colspan="2">template<detail::BitStreamInteger DataType> </td></tr>
<tr class="memitem:a8adc929ff06cf2c95d7d0a2e74b83b40"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfly_1_1_bit_stream_writer.html#a8adc929ff06cf2c95d7d0a2e74b83b40">write_bits</a> (DataType bits, byte_type size)</td></tr>
<tr class="separator:a8adc929ff06cf2c95d7d0a2e74b83b40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a4eae04f57794995a0c445b72073fbe"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfly_1_1_bit_stream_writer.html#a3a4eae04f57794995a0c445b72073fbe">finish</a> ()</td></tr>
<tr class="separator:a3a4eae04f57794995a0c445b72073fbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classfly_1_1detail_1_1_bit_stream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfly_1_1detail_1_1_bit_stream')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classfly_1_1detail_1_1_bit_stream.html">fly::detail::BitStream</a></td></tr>
<tr class="memitem:af64292199c3c8cf40aa1fbddc2645650 inherit pub_methods_classfly_1_1detail_1_1_bit_stream"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classfly_1_1detail_1_1_bit_stream.html#af64292199c3c8cf40aa1fbddc2645650">~BitStream</a> ()</td></tr>
<tr class="separator:af64292199c3c8cf40aa1fbddc2645650 inherit pub_methods_classfly_1_1detail_1_1_bit_stream"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classfly_1_1detail_1_1_bit_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classfly_1_1detail_1_1_bit_stream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classfly_1_1detail_1_1_bit_stream.html">fly::detail::BitStream</a></td></tr>
<tr class="memitem:a7e1e91c217c6d8d59e90bd6a1e0aac12 inherit pro_methods_classfly_1_1detail_1_1_bit_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfly_1_1detail_1_1_bit_stream.html#a7e1e91c217c6d8d59e90bd6a1e0aac12">BitStream</a> (std::streambuf *stream_buffer, byte_type starting_position) noexcept</td></tr>
<tr class="separator:a7e1e91c217c6d8d59e90bd6a1e0aac12 inherit pro_methods_classfly_1_1detail_1_1_bit_stream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66874d07d3cc560f82dde53e2924bf25 inherit pro_methods_classfly_1_1detail_1_1_bit_stream"><td class="memTemplParams" colspan="2">template<detail::BitStreamInteger DataType> </td></tr>
<tr class="memitem:a66874d07d3cc560f82dde53e2924bf25 inherit pro_methods_classfly_1_1detail_1_1_bit_stream"><td class="memTemplItemLeft" align="right" valign="top">DataType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfly_1_1detail_1_1_bit_stream.html#a66874d07d3cc560f82dde53e2924bf25">bit_mask</a> (const DataType bits)</td></tr>
<tr class="separator:a66874d07d3cc560f82dde53e2924bf25 inherit pro_methods_classfly_1_1detail_1_1_bit_stream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classfly_1_1detail_1_1_bit_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classfly_1_1detail_1_1_bit_stream')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classfly_1_1detail_1_1_bit_stream.html">fly::detail::BitStream</a></td></tr>
<tr class="memitem:afac2fc0345a934f0995c6efb778a90b1 inherit pro_attribs_classfly_1_1detail_1_1_bit_stream"><td class="memItemLeft" align="right" valign="top"><a id="afac2fc0345a934f0995c6efb778a90b1"></a>
std::streambuf * </td><td class="memItemRight" valign="bottom"><b>m_stream_buffer</b></td></tr>
<tr class="separator:afac2fc0345a934f0995c6efb778a90b1 inherit pro_attribs_classfly_1_1detail_1_1_bit_stream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a789ad3d52703af8cc466afd529565872 inherit pro_attribs_classfly_1_1detail_1_1_bit_stream"><td class="memItemLeft" align="right" valign="top"><a id="a789ad3d52703af8cc466afd529565872"></a>
buffer_type </td><td class="memItemRight" valign="bottom"><b>m_buffer</b> {0}</td></tr>
<tr class="separator:a789ad3d52703af8cc466afd529565872 inherit pro_attribs_classfly_1_1detail_1_1_bit_stream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7203dc65e683413c1a1bda194da974b inherit pro_attribs_classfly_1_1detail_1_1_bit_stream"><td class="memItemLeft" align="right" valign="top"><a id="ac7203dc65e683413c1a1bda194da974b"></a>
byte_type </td><td class="memItemRight" valign="bottom"><b>m_position</b> {0}</td></tr>
<tr class="separator:ac7203dc65e683413c1a1bda194da974b inherit pro_attribs_classfly_1_1detail_1_1_bit_stream"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of the BitStream interface for writing to a binary stream.</p>
<p>Bits are written to an in-memory byte buffer until that buffer is full, at which point that buffer is flushed to the stream. When done writing, callers should invoke the <a class="el" href="classfly_1_1_bit_stream_writer.html#a3a4eae04f57794995a0c445b72073fbe">finish()</a> method to flush the BitStream header and any bytes remaining in the buffer.</p>
<dl class="section author"><dt>Author</dt><dd>Timothy Flynn (<a href="#" onclick="location.href='mai'+'lto:'+'trf'+'ly'+'nn8'+'9@'+'pm.'+'me'; return false;">trfly<span style="display: none;">.nosp@m.</span>nn89<span style="display: none;">.nosp@m.</span>@pm.m<span style="display: none;">.nosp@m.</span>e</a>) </dd></dl>
<dl class="section version"><dt>Version</dt><dd>July 7, 2019 </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aac978a668121bd958d340f6f3d567ccf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac978a668121bd958d340f6f3d567ccf">◆ </a></span>BitStreamWriter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fly::BitStreamWriter::BitStreamWriter </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. Write the header byte onto the stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The stream to write binary data into. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3a4eae04f57794995a0c445b72073fbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a4eae04f57794995a0c445b72073fbe">◆ </a></span>finish()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool fly::BitStreamWriter::finish </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If needed, zero-fill the byte buffer, flush it to the stream, and update the header byte.</p>
<dl class="section return"><dt>Returns</dt><dd>True if the stream remains in a good state. </dd></dl>
</div>
</div>
<a id="a8adc929ff06cf2c95d7d0a2e74b83b40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8adc929ff06cf2c95d7d0a2e74b83b40">◆ </a></span>write_bits()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<detail::BitStreamInteger DataType> </div>
<table class="memname">
<tr>
<td class="memname">void fly::BitStreamWriter::write_bits </td>
<td>(</td>
<td class="paramtype">DataType </td>
<td class="paramname"><em>bits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte_type </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a number of bits to the byte buffer. The least-significant bits in the provided data type will be written, starting from the position pointed to by the provided number of bits.</p>
<p>Flush the buffer to the stream if it is filled during this operation.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">DataType</td><td>The data type storing the bits to write.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bits</td><td>The bits to write. </td></tr>
<tr><td class="paramname">size</td><td>The number of bits to write. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4c1d23024a1c07b13e32b78c52491367"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c1d23024a1c07b13e32b78c52491367">◆ </a></span>write_byte()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fly::BitStreamWriter::write_byte </td>
<td>(</td>
<td class="paramtype">byte_type </td>
<td class="paramname"><em>byte</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a full byte to the byte buffer.</p>
<p>Flush the buffer to the stream if it is filled during this operation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">byte</td><td>The byte to write. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8f28589dc377c9d8110cd86d82e249a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f28589dc377c9d8110cd86d82e249a6">◆ </a></span>write_word()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fly::BitStreamWriter::write_word </td>
<td>(</td>
<td class="paramtype">word_type </td>
<td class="paramname"><em>word</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a multibyte word to the byte buffer.</p>
<p>Flush the buffer to the stream if it is filled during this operation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>The word to write. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>fly/types/bit_stream/<a class="el" href="bit__stream__writer_8hpp_source.html">bit_stream_writer.hpp</a></li>
<li>fly/types/bit_stream/bit_stream_writer.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>fly</b></li><li class="navelem"><a class="el" href="classfly_1_1_bit_stream_writer.html">BitStreamWriter</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>