docs/bit__stream_8hpp_source.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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfly: fly/types/bit_stream/detail/bit_stream.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="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
   &#160;<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&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>
</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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('bit__stream_8hpp_source.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="headertitle">
<div class="title">bit_stream.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="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &quot;fly/types/bit_stream/detail/concepts.hpp&quot;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &quot;fly/types/bit_stream/types.hpp&quot;</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">#include &lt;limits&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#include &lt;streambuf&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="keyword">namespace </span>fly::detail {</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classfly_1_1detail_1_1_bit_stream.html">   33</a></span>&#160;<span class="keyword">class </span><a class="code" href="classfly_1_1detail_1_1_bit_stream.html">BitStream</a></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;{</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classfly_1_1detail_1_1_bit_stream.html#af64292199c3c8cf40aa1fbddc2645650">   39</a></span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classfly_1_1detail_1_1_bit_stream.html#af64292199c3c8cf40aa1fbddc2645650">~BitStream</a>();</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;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <a class="code" href="classfly_1_1detail_1_1_bit_stream.html#a7e1e91c217c6d8d59e90bd6a1e0aac12">BitStream</a>(std::streambuf *stream_buffer, byte_type starting_position) noexcept;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    <span class="keyword">template</span> &lt;detail::BitStreamInteger DataType&gt;</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    DataType <a class="code" href="classfly_1_1detail_1_1_bit_stream.html#a66874d07d3cc560f82dde53e2924bf25">bit_mask</a>(<span class="keyword">const</span> DataType bits);</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    std::streambuf *m_stream_buffer;</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    buffer_type m_buffer {0};</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    byte_type m_position {0};</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;};</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment">//==================================================================================================</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keyword">template</span> &lt;detail::BitStreamInteger DataType&gt;</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classfly_1_1detail_1_1_bit_stream.html#a66874d07d3cc560f82dde53e2924bf25">   71</a></span>&#160;<span class="keyword">inline</span> DataType <a class="code" href="classfly_1_1detail_1_1_bit_stream.html#a66874d07d3cc560f82dde53e2924bf25">BitStream::bit_mask</a>(<span class="keyword">const</span> DataType bits)</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;{</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keyword">static</span> constexpr <span class="keyword">auto</span> s_filled = std::numeric_limits&lt;DataType&gt;::max();</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keyword">static</span> constexpr <span class="keyword">auto</span> s_digits = std::numeric_limits&lt;DataType&gt;::digits;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordflow">return</span> (bits == 0) ? 0 : s_filled &gt;&gt; (s_digits - bits);</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;}</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;} <span class="comment">// namespace fly::detail</span></div>
<div class="ttc" id="aclassfly_1_1detail_1_1_bit_stream_html"><div class="ttname"><a href="classfly_1_1detail_1_1_bit_stream.html">fly::detail::BitStream</a></div><div class="ttdef"><b>Definition:</b> bit_stream.hpp:34</div></div>
<div class="ttc" id="aclassfly_1_1detail_1_1_bit_stream_html_a66874d07d3cc560f82dde53e2924bf25"><div class="ttname"><a href="classfly_1_1detail_1_1_bit_stream.html#a66874d07d3cc560f82dde53e2924bf25">fly::detail::BitStream::bit_mask</a></div><div class="ttdeci">DataType bit_mask(const DataType bits)</div><div class="ttdef"><b>Definition:</b> bit_stream.hpp:71</div></div>
<div class="ttc" id="aclassfly_1_1detail_1_1_bit_stream_html_a7e1e91c217c6d8d59e90bd6a1e0aac12"><div class="ttname"><a href="classfly_1_1detail_1_1_bit_stream.html#a7e1e91c217c6d8d59e90bd6a1e0aac12">fly::detail::BitStream::BitStream</a></div><div class="ttdeci">BitStream(std::streambuf *stream_buffer, byte_type starting_position) noexcept</div><div class="ttdef"><b>Definition:</b> bit_stream.cpp:6</div></div>
<div class="ttc" id="aclassfly_1_1detail_1_1_bit_stream_html_af64292199c3c8cf40aa1fbddc2645650"><div class="ttname"><a href="classfly_1_1detail_1_1_bit_stream.html#af64292199c3c8cf40aa1fbddc2645650">fly::detail::BitStream::~BitStream</a></div><div class="ttdeci">virtual ~BitStream()</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_4e888731a8ba874a656d519f9f1001d8.html">fly</a></li><li class="navelem"><a class="el" href="dir_666f9a7ac6e05881746e5257b80aca61.html">types</a></li><li class="navelem"><a class="el" href="dir_b7d285753531f12a3e100ba4a548ea71.html">bit_stream</a></li><li class="navelem"><a class="el" href="dir_91af7152f0fb97955b79630a27c00ab0.html">detail</a></li><li class="navelem"><b>bit_stream.hpp</b></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>