CDevJoud/Minecraft-Community-Edition
1
0
Fork 0
mirror of https://github.com/CDevJoud/Minecraft-Community-Edition.git synced 2026-07-16 07:40:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
21f6bb92ce50ddcfed0e9b62a71419c21a3d16a5
Minecraft-Community-Edition/doc/html/_file_input_stream_8hpp_source.html
Joud Kandeel 0f6c725345 updated the docs
2026-04-02 13:39:23 +02:00

162 lines
15 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Minecraft Community Edition: Minecraft-Community-Edition/IO/Stream/FileInputStream.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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Minecraft Community Edition<span id="projectnumber">&#160;0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</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">
$(function(){initNavTree('_file_input_stream_8hpp_source.html','',''); });
</script>
<div id="container">
<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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">FileInputStream.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;..\..\Platform.hpp&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;fstream&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;InputStream.hpp&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;EASTL/string_view.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#ifdef MCE_PLATFORM_WINDOWS</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#ifdef INVALID_FILE_SIZE</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#undef INVALID_FILE_SIZE</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">namespace </span>mce::io::stream {</div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1_file_input_stream.html"> 17</a></span> <span class="keyword">class </span>FileInputStream final : <span class="keyword">public</span> InputStream {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> FileInputStream();</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> ~FileInputStream();</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="comment">//explicit FileInputStream(eastl::string_view file);</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ab7e50aadebd4197b5265d73b1e8525c9"> 31</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ab7e50aadebd4197b5265d73b1e8525c9">open</a>(<span class="keyword">const</span> std::string&amp; file);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ac7a544d4bdaab0f51c40e697870ed81b"> 36</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ac7a544d4bdaab0f51c40e697870ed81b">isOpen</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a71114ce3a2363940b2e952d6f58df79b"> 41</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a71114ce3a2363940b2e952d6f58df79b">close</a>();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a6ca2b2bb43e44cd8b43066f557b5a911"> 49</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a6ca2b2bb43e44cd8b43066f557b5a911">read</a>(<span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a0f9babfbeac96f147752ffe41cff1ca4"> 56</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a0f9babfbeac96f147752ffe41cff1ca4">seek</a>(<span class="keywordtype">size_t</span> position) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ad0fac06330b8408a3c5615bbcd37bf50"> 61</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ad0fac06330b8408a3c5615bbcd37bf50">tell</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a96009fb45d364e5b7f0d52abaa149a45"> 66</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a96009fb45d364e5b7f0d52abaa149a45">getSize</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">size_t</span> FILE_NOT_FOUND = 0;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">size_t</span> INVALID_FILE_SIZE = ~(0);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">size_t</span> INVALID_FILE_POSITION = ~(0);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="preprocessor">#ifdef MCE_PLATFORM_WINDOWS</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">void</span>* __ptr64 hFile = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="preprocessor">#elif defined(MCE_PLATFORM_LINUX) || defined(MCE_PLATFORM_MACOS)</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> std::FILE* file;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> };</div>
</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>}</div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_input_stream_html_a0f9babfbeac96f147752ffe41cff1ca4"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a0f9babfbeac96f147752ffe41cff1ca4">mce::io::stream::FileInputStream::seek</a></div><div class="ttdeci">size_t seek(size_t position) override</div><div class="ttdoc">Changes the current position the stream is reading.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_input_stream_html_a6ca2b2bb43e44cd8b43066f557b5a911"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a6ca2b2bb43e44cd8b43066f557b5a911">mce::io::stream::FileInputStream::read</a></div><div class="ttdeci">size_t read(void *buffer, size_t size) override</div><div class="ttdoc">Reads from the input stream.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_input_stream_html_a71114ce3a2363940b2e952d6f58df79b"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a71114ce3a2363940b2e952d6f58df79b">mce::io::stream::FileInputStream::close</a></div><div class="ttdeci">void close()</div><div class="ttdoc">Closes the file.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_input_stream_html_a96009fb45d364e5b7f0d52abaa149a45"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#a96009fb45d364e5b7f0d52abaa149a45">mce::io::stream::FileInputStream::getSize</a></div><div class="ttdeci">size_t getSize() override</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_input_stream_html_ab7e50aadebd4197b5265d73b1e8525c9"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ab7e50aadebd4197b5265d73b1e8525c9">mce::io::stream::FileInputStream::open</a></div><div class="ttdeci">bool open(const std::string &amp;file)</div><div class="ttdoc">Constructs the stream and opens a file.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_input_stream_html_ac7a544d4bdaab0f51c40e697870ed81b"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ac7a544d4bdaab0f51c40e697870ed81b">mce::io::stream::FileInputStream::isOpen</a></div><div class="ttdeci">bool isOpen() const</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_input_stream_html_ad0fac06330b8408a3c5615bbcd37bf50"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_input_stream.html#ad0fac06330b8408a3c5615bbcd37bf50">mce::io::stream::FileInputStream::tell</a></div><div class="ttdeci">size_t tell() override</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>Minecraft-Community-Edition</b></li><li class="navelem"><b>IO</b></li><li class="navelem"><b>Stream</b></li><li class="navelem"><b>FileInputStream.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.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink