-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFileInputStream_8hpp_source.htm
More file actions
131 lines (131 loc) · 14.9 KB
/
Copy pathFileInputStream_8hpp_source.htm
File metadata and controls
131 lines (131 loc) · 14.9 KB
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
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpp3ds · Documentation</title>
<link rel="stylesheet" href="../css/app.css" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script src="../bower_components/modernizr/modernizr.js"></script>
</head>
<body>
<div id="topnav" class="text-center">
<dl class="sub-nav">
<dd id="navlogo"><a href="/">
<img src="../img/logo.svg" />
</a></dd>
<dd><a href="/#what">What is it?</a></dd>
<dd><a href="/#download">Download</a></dd>
<dd><a href="/#faqs">FAQs</a></dd>
<dd class="active"><a href="/docs">Docs</a></dd>
</dl>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0b93ed46ee854382aab85c778b89946e.htm">include</a></li><li class="navelem"><a class="el" href="dir_18d409fe281a3b15bd325ab753ead42a.htm">cpp3ds</a></li><li class="navelem"><a class="el" href="dir_c5c778fd8c9c629bd120f7f9ff00b45a.htm">System</a></li> </ul>
</div>
</div><!-- top -->
<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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// you must not claim that you wrote the original software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and must not be misrepresented as being the original software.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">//</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef CPP3DS_FILEINPUTSTREAM_HPP</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define CPP3DS_FILEINPUTSTREAM_HPP</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Headers</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#include <cpp3ds/Config.hpp></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <cpp3ds/System/InputStream.hpp></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <cpp3ds/System/NonCopyable.hpp></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <cstdio></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <string></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="keyword">namespace </span><a class="code" href="namespacecpp3ds.htm">cpp3ds</a></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1FileInputStream.htm"> 44</a></span> <span class="keyword">class </span><a class="code" href="classcpp3ds_1_1FileInputStream.htm">FileInputStream</a> : <span class="keyword">public</span> <a class="code" href="classcpp3ds_1_1InputStream.htm">InputStream</a>, <a class="code" href="classcpp3ds_1_1NonCopyable.htm">NonCopyable</a></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classcpp3ds_1_1FileInputStream.htm#a421575cdcf7c943aa1e0f867cea43297">FileInputStream</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> <a class="code" href="classcpp3ds_1_1FileInputStream.htm#a460d05dde1ac9cb633f2228d43ebf89e">~FileInputStream</a>();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1FileInputStream.htm#a3dd67d991ea4267cfdc2b74f79cdebc1">open</a>(<span class="keyword">const</span> std::string& filename);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span> Int64 <a class="code" href="classcpp3ds_1_1FileInputStream.htm#a8b896cd680f7b494fb6f61672f0976a2">read</a>(<span class="keywordtype">void</span>* data, Int64 size);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">virtual</span> Int64 <a class="code" href="classcpp3ds_1_1FileInputStream.htm#a4c08a96a5c851bf55a7b7ad413848e13">seek</a>(Int64 position);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">virtual</span> Int64 <a class="code" href="classcpp3ds_1_1FileInputStream.htm#a8c2e7e9d4d22660f1da6b71dffa68dae">tell</a>();</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">virtual</span> Int64 <a class="code" href="classcpp3ds_1_1FileInputStream.htm#a524bc5773c0928ad0782c794a9190251">getSize</a>();</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// Member data</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"></span> std::FILE* m_file; </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> };</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> } <span class="comment">// namespace cpp3ds</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#endif // CPP3DS_FILEINPUTSTREAM_HPP</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="ttc" id="classcpp3ds_1_1InputStream_htm"><div class="ttname"><a href="classcpp3ds_1_1InputStream.htm">cpp3ds::InputStream</a></div><div class="ttdoc">Abstract class for custom file input streams. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8hpp_source.htm#l00040">InputStream.hpp:40</a></div></div>
<div class="ttc" id="namespacecpp3ds_htm"><div class="ttname"><a href="namespacecpp3ds.htm">cpp3ds</a></div><div class="ttdef"><b>Definition:</b> <a href="AlResource_8hpp_source.htm#l00033">AlResource.hpp:33</a></div></div>
<div class="ttc" id="classcpp3ds_1_1FileInputStream_htm_a8b896cd680f7b494fb6f61672f0976a2"><div class="ttname"><a href="classcpp3ds_1_1FileInputStream.htm#a8b896cd680f7b494fb6f61672f0976a2">cpp3ds::FileInputStream::read</a></div><div class="ttdeci">virtual Int64 read(void *data, Int64 size)</div><div class="ttdoc">Read data from the stream. </div></div>
<div class="ttc" id="classcpp3ds_1_1FileInputStream_htm_a8c2e7e9d4d22660f1da6b71dffa68dae"><div class="ttname"><a href="classcpp3ds_1_1FileInputStream.htm#a8c2e7e9d4d22660f1da6b71dffa68dae">cpp3ds::FileInputStream::tell</a></div><div class="ttdeci">virtual Int64 tell()</div><div class="ttdoc">Get the current reading position in the stream. </div></div>
<div class="ttc" id="classcpp3ds_1_1FileInputStream_htm_a4c08a96a5c851bf55a7b7ad413848e13"><div class="ttname"><a href="classcpp3ds_1_1FileInputStream.htm#a4c08a96a5c851bf55a7b7ad413848e13">cpp3ds::FileInputStream::seek</a></div><div class="ttdeci">virtual Int64 seek(Int64 position)</div><div class="ttdoc">Change the current reading position. </div></div>
<div class="ttc" id="classcpp3ds_1_1FileInputStream_htm_a460d05dde1ac9cb633f2228d43ebf89e"><div class="ttname"><a href="classcpp3ds_1_1FileInputStream.htm#a460d05dde1ac9cb633f2228d43ebf89e">cpp3ds::FileInputStream::~FileInputStream</a></div><div class="ttdeci">virtual ~FileInputStream()</div><div class="ttdoc">Default destructor. </div></div>
<div class="ttc" id="classcpp3ds_1_1FileInputStream_htm_a524bc5773c0928ad0782c794a9190251"><div class="ttname"><a href="classcpp3ds_1_1FileInputStream.htm#a524bc5773c0928ad0782c794a9190251">cpp3ds::FileInputStream::getSize</a></div><div class="ttdeci">virtual Int64 getSize()</div><div class="ttdoc">Return the size of the stream. </div></div>
<div class="ttc" id="classcpp3ds_1_1NonCopyable_htm"><div class="ttname"><a href="classcpp3ds_1_1NonCopyable.htm">cpp3ds::NonCopyable</a></div><div class="ttdoc">Utility class that makes any derived class non-copyable. </div><div class="ttdef"><b>Definition:</b> <a href="NonCopyable_8hpp_source.htm#l00035">NonCopyable.hpp:35</a></div></div>
<div class="ttc" id="classcpp3ds_1_1FileInputStream_htm_a3dd67d991ea4267cfdc2b74f79cdebc1"><div class="ttname"><a href="classcpp3ds_1_1FileInputStream.htm#a3dd67d991ea4267cfdc2b74f79cdebc1">cpp3ds::FileInputStream::open</a></div><div class="ttdeci">bool open(const std::string &filename)</div><div class="ttdoc">Open the stream from a file path. </div></div>
<div class="ttc" id="classcpp3ds_1_1FileInputStream_htm_a421575cdcf7c943aa1e0f867cea43297"><div class="ttname"><a href="classcpp3ds_1_1FileInputStream.htm#a421575cdcf7c943aa1e0f867cea43297">cpp3ds::FileInputStream::FileInputStream</a></div><div class="ttdeci">FileInputStream()</div><div class="ttdoc">Default constructor. </div></div>
<div class="ttc" id="classcpp3ds_1_1FileInputStream_htm"><div class="ttname"><a href="classcpp3ds_1_1FileInputStream.htm">cpp3ds::FileInputStream</a></div><div class="ttdoc">Implementation of input stream based on a file. </div><div class="ttdef"><b>Definition:</b> <a href="FileInputStream_8hpp_source.htm#l00044">FileInputStream.hpp:44</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML Copyright © Laurent Gomila
</div>
</div>
</body>
</html>