mirror of https://github.com/libAthena/athena.git
128 lines
18 KiB
HTML
128 lines
18 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.11"/>
|
|
<title>Athena IO Library: include/athena/FileReader.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>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">Athena IO Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<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 Page</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 List</span></a></li>
|
|
</ul>
|
|
</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">
|
|
$(document).ready(function(){initNavTree('_file_reader_8hpp_source.html','');});
|
|
</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">FileReader.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef FILESTREAM_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define FILESTREAM_HPP</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 <string></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <stdio.h></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "athena/IStreamReader.hpp"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">namespace </span><a class="code" href="namespaceathena.html">athena</a></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> {</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span>io</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classathena_1_1io_1_1_file_reader.html"> 13</a></span> <span class="keyword">class </span><a class="code" href="classathena_1_1io_1_1_file_reader.html">FileReader</a> : <span class="keyword">public</span> <a class="code" href="classathena_1_1io_1_1_i_stream_reader.html">IStreamReader</a></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="classathena_1_1io_1_1_file_reader.html">FileReader</a>(<span class="keyword">const</span> std::string& filename, atInt32 cacheSize = (32 * 1024), <span class="keywordtype">bool</span> globalErr=<span class="keyword">true</span>);</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <a class="code" href="classathena_1_1io_1_1_file_reader.html">FileReader</a>(<span class="keyword">const</span> std::wstring& filename, atInt32 cacheSize = (32 * 1024), <span class="keywordtype">bool</span> globalErr=<span class="keyword">true</span>);</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">virtual</span> ~<a class="code" href="classathena_1_1io_1_1_file_reader.html">FileReader</a>();</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">inline</span> std::string filename()<span class="keyword"> const</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#if _WIN32</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">return</span> utility::wideToUtf8(m_filename);</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordflow">return</span> m_filename;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  }</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="keyword">inline</span> std::wstring wfilename()<span class="keyword"> const</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#if _WIN32</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">return</span> m_filename;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">return</span> utility::utf8ToWide(m_filename);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#endif</span></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="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> open();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> close();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> isOpen()<span class="keyword"> const</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword"> </span>{<span class="keywordflow">return</span> m_fileHandle != NULL;}</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">bool</span> save();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> <a class="code" href="classathena_1_1io_1_1_file_reader.html#a38c4949a6e442ff25a4019eb8b907bf4">seek</a>(atInt64 pos, SeekOrigin origin = SeekOrigin::Current);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  atUint64 <a class="code" href="classathena_1_1io_1_1_file_reader.html#aa710828155a508684875ba1015b2bdcf">position</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  atUint64 <a class="code" href="classathena_1_1io_1_1_file_reader.html#a7077560fb12c77ef36acfa75076725e2">length</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  atUint64 <a class="code" href="classathena_1_1io_1_1_file_reader.html#ac064f55711ec2237358bdc4842dc1ab3">readUBytesToBuf</a>(<span class="keywordtype">void</span>* buf, atUint64 len);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> setCacheSize(<span class="keyword">const</span> atInt32 blockSize);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  FILE* _fileHandle() {<span class="keywordflow">return</span> m_fileHandle;}</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#if _WIN32</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  std::wstring m_filename;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  std::string m_filename;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  FILE* m_fileHandle;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  std::unique_ptr<atUint8[]> m_cacheData;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  atInt32 m_blockSize;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  atInt32 m_curBlock;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  atUint64 m_offset;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> m_globalErr;</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> } <span class="comment">// io</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> } <span class="comment">// Athena</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#ifndef FILEREADER_BASE</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#define FILEREADER_BASE() \</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">private: \</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> typedef athena::io::FileReader base</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif // FILEREADER_BASE</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif // FILESTREAM_HPP</span></div><div class="ttc" id="classathena_1_1io_1_1_file_reader_html_aa710828155a508684875ba1015b2bdcf"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html#aa710828155a508684875ba1015b2bdcf">athena::io::FileReader::position</a></div><div class="ttdeci">atUint64 position() const </div><div class="ttdoc">Returns the current position in the stream. </div></div>
|
|
<div class="ttc" id="classathena_1_1io_1_1_file_reader_html_a7077560fb12c77ef36acfa75076725e2"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html#a7077560fb12c77ef36acfa75076725e2">athena::io::FileReader::length</a></div><div class="ttdeci">atUint64 length() const </div><div class="ttdoc">Returns the length of the file. </div></div>
|
|
<div class="ttc" id="classathena_1_1io_1_1_i_stream_reader_html"><div class="ttname"><a href="classathena_1_1io_1_1_i_stream_reader.html">athena::io::IStreamReader</a></div><div class="ttdoc">The IStreamReader class defines a basic API for reading from streams, Implementors are provided with ...</div><div class="ttdef"><b>Definition:</b> <a href="_i_stream_reader_8hpp_source.html#l00018">IStreamReader.hpp:18</a></div></div>
|
|
<div class="ttc" id="namespaceathena_html"><div class="ttname"><a href="namespaceathena.html">athena</a></div><div class="ttdef"><b>Definition:</b> <a href="_a_l_t_t_p_enums_8hpp_source.html#l00006">ALTTPEnums.hpp:6</a></div></div>
|
|
<div class="ttc" id="classathena_1_1io_1_1_file_reader_html_a38c4949a6e442ff25a4019eb8b907bf4"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html#a38c4949a6e442ff25a4019eb8b907bf4">athena::io::FileReader::seek</a></div><div class="ttdeci">void seek(atInt64 pos, SeekOrigin origin=SeekOrigin::Current)</div><div class="ttdoc">Sets the buffers position relative to the specified position. It seeks relative to the current posit...</div></div>
|
|
<div class="ttc" id="classathena_1_1io_1_1_file_reader_html_ac064f55711ec2237358bdc4842dc1ab3"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html#ac064f55711ec2237358bdc4842dc1ab3">athena::io::FileReader::readUBytesToBuf</a></div><div class="ttdeci">atUint64 readUBytesToBuf(void *buf, atUint64 len)</div><div class="ttdoc">Attempts to read a fixed length of data into a pre-allocated buffer, this function is client defined ...</div></div>
|
|
<div class="ttc" id="classathena_1_1io_1_1_file_reader_html"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html">athena::io::FileReader</a></div><div class="ttdef"><b>Definition:</b> <a href="_file_reader_8hpp_source.html#l00013">FileReader.hpp:13</a></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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9b3fbfcb7fc609b7105d1ff63111043b.html">athena</a></li><li class="navelem"><b>FileReader.hpp</b></li>
|
|
<li class="footer">Generated on Sat Sep 17 2016 13:10:08 for Athena IO Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|