cpp-utilities/doc/html/binaryreader_8h_source.html

184 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8"/>
<title>Utilities: io/binaryreader.h 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Utilities
&#160;<span id="projectnumber">1</span>
</div>
<div id="projectbrief">Collection of utility classes and functions used by my C++ applications.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a></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_bc161955dc3a3d2485839eba21420d01.html">io</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">binaryreader.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="binaryreader_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef BINERYREADER_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define BINERYREADER_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;../application/global.h&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;../conversion/types.h&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;../conversion/binaryconversion.h&quot;</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;vector&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;istream&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceIoUtilities.html">IoUtilities</a></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;{</div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classIoUtilities_1_1BinaryReader.html"> 14</a></span>&#160; <span class="keyword">class </span><a class="code" href="global_8h.html#ab628e42bb29ed7b1ca25e8c54aeb77d3">LIB_EXPORT</a> <a class="code" href="classIoUtilities_1_1BinaryReader.html">BinaryReader</a></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; {</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">public</span>:</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <a class="code" href="classIoUtilities_1_1BinaryReader.html">BinaryReader</a>(std::istream *stream, <a class="code" href="namespaceConversionUtilities.html#ab037dd2e3add89397e710e087b9e6462">ConversionUtilities::ByteOrder</a> byteOrder = <a class="code" href="namespaceConversionUtilities.html#ab037dd2e3add89397e710e087b9e6462a3c0ba6b22b526d7fd50c3026435a8c02">ConversionUtilities::ByteOrder::LittleEndian</a>);</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <a class="code" href="classIoUtilities_1_1BinaryReader.html">BinaryReader</a>(<span class="keyword">const</span> <a class="code" href="classIoUtilities_1_1BinaryReader.html">BinaryReader</a> &amp;other);</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <a class="code" href="classIoUtilities_1_1BinaryReader.html">BinaryReader</a> &amp; operator=(<span class="keyword">const</span> <a class="code" href="classIoUtilities_1_1BinaryReader.html">BinaryReader</a> &amp; rhs) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; ~<a class="code" href="classIoUtilities_1_1BinaryReader.html">BinaryReader</a>();</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">const</span> std::istream *stream() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; std::istream *stream();</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">void</span> setStream(std::istream *stream, <span class="keywordtype">bool</span> giveOwnership = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">bool</span> hasOwnership() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">void</span> giveOwnership();</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">void</span> detatchOwnership();</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="namespaceConversionUtilities.html#ab037dd2e3add89397e710e087b9e6462">ConversionUtilities::ByteOrder</a> byteOrder() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">void</span> setByteOrder(<a class="code" href="namespaceConversionUtilities.html#ab037dd2e3add89397e710e087b9e6462">ConversionUtilities::ByteOrder</a> value);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">bool</span> fail() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">bool</span> eof() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">bool</span> canRead() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; std::istream::pos_type readStreamsize();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> read(<span class="keywordtype">char</span> *buffer, std::streamsize length);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">void</span> read(<a class="code" href="types_8h.html#a61902b37514c53f51a2fb8423db5ee36">byte</a> *buffer, std::streamsize length);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">void</span> read(std::vector&lt;char&gt; &amp;buffer, std::streamsize length);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="types_8h.html#aecf4e3680a32207d17f62a3426731878">int16</a> readInt16();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="types_8h.html#ad9c79638db63f1dfe2b085743b5cbf7b">uint16</a> readUInt16();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="types_8h.html#a0bf9964a3ce962c07ad3d8b5432bbbcd">int32</a> readInt24();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="types_8h.html#a22f78cc9780bf32aff91ae17c3101c8d">uint32</a> readUInt24();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="types_8h.html#a0bf9964a3ce962c07ad3d8b5432bbbcd">int32</a> readInt32();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="types_8h.html#a22f78cc9780bf32aff91ae17c3101c8d">uint32</a> readUInt32();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="types_8h.html#ad7a3bd3be7bd59e7fb6337fcbc956eb1">int64</a> readInt64();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="types_8h.html#ac4dd6ce78ce3b840c53bd4b3c63ed09b">uint64</a> readUInt64();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; float32 readFloat32();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; float64 readFloat64();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">char</span> readChar();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="types_8h.html#a61902b37514c53f51a2fb8423db5ee36">byte</a> readByte();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">bool</span> readBool();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; std::string readLengthPrefixedString();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; std::string readString(<span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; std::string readTerminatedString(<a class="code" href="types_8h.html#a61902b37514c53f51a2fb8423db5ee36">byte</a> termination = 0);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; std::string readTerminatedString(<span class="keywordtype">size_t</span> maxBytesToRead, <a class="code" href="types_8h.html#a61902b37514c53f51a2fb8423db5ee36">byte</a> termination = 0);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; std::string readMultibyteTerminatedString(<a class="code" href="types_8h.html#ad9c79638db63f1dfe2b085743b5cbf7b">uint16</a> termination = 0);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; std::string readMultibyteTerminatedString(<span class="keywordtype">size_t</span> maxBytesToRead, <a class="code" href="types_8h.html#ad9c79638db63f1dfe2b085743b5cbf7b">uint16</a> termination = 0);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="types_8h.html#a22f78cc9780bf32aff91ae17c3101c8d">uint32</a> readSynchsafeUInt32();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="types_8h.html#a22f78cc9780bf32aff91ae17c3101c8d">uint32</a> readCrc32(<span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">static</span> <a class="code" href="types_8h.html#a22f78cc9780bf32aff91ae17c3101c8d">uint32</a> *crc32Table();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; std::istream *m_stream;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">bool</span> m_ownership;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; std::istream::pos_type m_streamsize;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="namespaceConversionUtilities.html#ab037dd2e3add89397e710e087b9e6462">ConversionUtilities::ByteOrder</a> m_byteOrder;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</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;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#endif // BINERYREADER_H</span></div>
<div class="ttc" id="namespaceConversionUtilities_html_ab037dd2e3add89397e710e087b9e6462"><div class="ttname"><a href="namespaceConversionUtilities.html#ab037dd2e3add89397e710e087b9e6462">ConversionUtilities::ByteOrder</a></div><div class="ttdeci">ByteOrder</div><div class="ttdoc">Specifies the byte order/endianness. </div><div class="ttdef"><b>Definition:</b> <a href="binaryconversion_8h_source.html#l00040">binaryconversion.h:40</a></div></div>
<div class="ttc" id="types_8h_html_ad7a3bd3be7bd59e7fb6337fcbc956eb1"><div class="ttname"><a href="types_8h.html#ad7a3bd3be7bd59e7fb6337fcbc956eb1">int64</a></div><div class="ttdeci">std::int64_t int64</div><div class="ttdoc">signed 64-bit integer </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00029">types.h:29</a></div></div>
<div class="ttc" id="classIoUtilities_1_1BinaryReader_html"><div class="ttname"><a href="classIoUtilities_1_1BinaryReader.html">IoUtilities::BinaryReader</a></div><div class="ttdoc">Reads primitive data types from a std::istream using a specified ConversionUtilities::ByteOrder. </div><div class="ttdef"><b>Definition:</b> <a href="binaryreader_8h_source.html#l00014">binaryreader.h:14</a></div></div>
<div class="ttc" id="namespaceConversionUtilities_html_ab037dd2e3add89397e710e087b9e6462a3c0ba6b22b526d7fd50c3026435a8c02"><div class="ttname"><a href="namespaceConversionUtilities.html#ab037dd2e3add89397e710e087b9e6462a3c0ba6b22b526d7fd50c3026435a8c02">ConversionUtilities::ByteOrder::LittleEndian</a></div></div>
<div class="ttc" id="global_8h_html_ab628e42bb29ed7b1ca25e8c54aeb77d3"><div class="ttname"><a href="global_8h.html#ab628e42bb29ed7b1ca25e8c54aeb77d3">LIB_EXPORT</a></div><div class="ttdeci">#define LIB_EXPORT</div><div class="ttdoc">This macro marks a symbol for shared library export. </div><div class="ttdef"><b>Definition:</b> <a href="global_8h_source.html#l00050">global.h:50</a></div></div>
<div class="ttc" id="types_8h_html_ac4dd6ce78ce3b840c53bd4b3c63ed09b"><div class="ttname"><a href="types_8h.html#ac4dd6ce78ce3b840c53bd4b3c63ed09b">uint64</a></div><div class="ttdeci">std::uint64_t uint64</div><div class="ttdoc">unsigned 64-bit integer </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00049">types.h:49</a></div></div>
<div class="ttc" id="namespaceIoUtilities_html"><div class="ttname"><a href="namespaceIoUtilities.html">IoUtilities</a></div><div class="ttdoc">Contains utility classes helping to read and write streams. </div></div>
<div class="ttc" id="types_8h_html_a22f78cc9780bf32aff91ae17c3101c8d"><div class="ttname"><a href="types_8h.html#a22f78cc9780bf32aff91ae17c3101c8d">uint32</a></div><div class="ttdeci">std::uint32_t uint32</div><div class="ttdoc">unsigned 32-bit integer </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00044">types.h:44</a></div></div>
<div class="ttc" id="types_8h_html_a0bf9964a3ce962c07ad3d8b5432bbbcd"><div class="ttname"><a href="types_8h.html#a0bf9964a3ce962c07ad3d8b5432bbbcd">int32</a></div><div class="ttdeci">std::int32_t int32</div><div class="ttdoc">signed 32-bit integer </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00024">types.h:24</a></div></div>
<div class="ttc" id="types_8h_html_a61902b37514c53f51a2fb8423db5ee36"><div class="ttname"><a href="types_8h.html#a61902b37514c53f51a2fb8423db5ee36">byte</a></div><div class="ttdeci">std::uint8_t byte</div><div class="ttdoc">unsigned byte </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00014">types.h:14</a></div></div>
<div class="ttc" id="types_8h_html_aecf4e3680a32207d17f62a3426731878"><div class="ttname"><a href="types_8h.html#aecf4e3680a32207d17f62a3426731878">int16</a></div><div class="ttdeci">std::int16_t int16</div><div class="ttdoc">signed 16-bit integer </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00019">types.h:19</a></div></div>
<div class="ttc" id="types_8h_html_ad9c79638db63f1dfe2b085743b5cbf7b"><div class="ttname"><a href="types_8h.html#ad9c79638db63f1dfe2b085743b5cbf7b">uint16</a></div><div class="ttdeci">std::uint16_t uint16</div><div class="ttdoc">unsigned 16-bit integer </div><div class="ttdef"><b>Definition:</b> <a href="types_8h_source.html#l00039">types.h:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 15 2014 15:40:10 for Utilities by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>