1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     fs_FileStream.h
4 
5   Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.
6 
7   These coded instructions, statements, and computer programs contain
8   proprietary information of Nintendo of America Inc. and/or Nintendo
9   Company Ltd., and are protected by Federal copyright law. They may
10   not be disclosed to third parties or copied or duplicated in any form,
11   in whole or in part, without the prior written consent of Nintendo.
12 
13   $Rev: 36362 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_FS_FS_FILESTREAM_H_
17 #define NN_FS_FS_FILESTREAM_H_
18 
19 #include <nn/fs/fs_IStream.h>
20 #include <nn/fs/fs_FileBase.h>
21 #include <nn/fnd/fnd_Storage.h>
22 
23 namespace nn { namespace fs {
24 
25 /* Please see man pages for details
26 
27 
28 
29 
30 
31 
32 
33 
34 
35 
36 
37 
38 */
39 class FileStream : public IStream, public detail::FileBase, private nn::util::NonCopyable<FileStream>
40 {
41 public:
42 
43     /* Please see man pages for details
44 
45 
46 
47 
48 
49     */
FileStream()50     FileStream() {}
51 
52     /* Please see man pages for details
53 
54 
55 
56 
57 
58 
59 
60 
61 
62 
63 
64 
65 
66     */
FileStream(const wchar_t * pathName,bit32 openMode)67     FileStream(const wchar_t* pathName, bit32 openMode) : detail::FileBase(pathName, openMode) {}
68 
69     /* Please see man pages for details
70 
71 
72 
73 
74 
75 
76 
77 
78 
79 
80 
81 
82 
83 
84 
85 
86     */
FileStream(const char * pathName,bit32 openMode)87     FileStream(const char* pathName, bit32 openMode) : detail::FileBase(pathName, openMode) {}
88 
89     /* Please see man pages for details
90 
91 
92 
93 
94 
95 
96 
97 
98 
99 
100 
101 
102 
103 
104 
105     */
Initialize(const wchar_t * pathName,bit32 openMode)106     void Initialize(const wchar_t* pathName, bit32 openMode) { detail::FileBase::Initialize(pathName, openMode); }
107 
108     /* Please see man pages for details
109 
110 
111 
112 
113 
114 
115 
116 
117 
118 
119 
120 
121 
122 
123 
124 
125 
126 
127     */
Initialize(const char * pathName,bit32 openMode)128     void Initialize(const char* pathName, bit32 openMode) { detail::FileBase::Initialize(pathName, openMode); }
129 
130     /* Please see man pages for details
131 
132 
133 
134 
135 
136 
137 
138 
139 
140 
141 
142 
143 
144 
145 
146 
147 
148 
149 
150     */
TryInitialize(const wchar_t * pathName,bit32 openMode)151     nn::Result TryInitialize(const wchar_t* pathName, bit32 openMode) { return detail::FileBase::TryInitialize(pathName, openMode); }
152 
153     /* Please see man pages for details
154 
155 
156 
157 
158 
159 
160 
161 
162 
163 
164 
165 
166 
167 
168 
169 
170 
171 
172 
173 
174     */
TryInitialize(const char * pathName,bit32 openMode)175     nn::Result TryInitialize(const char* pathName, bit32 openMode) { return detail::FileBase::TryInitialize(pathName, openMode); }
176 
177     /* Please see man pages for details
178 
179 
180 
181     */
Finalize()182     void Finalize() { detail::FileBase::Finalize(); }
183 
184     /* Please see man pages for details
185 
186 
187 
188     */
~FileStream()189     virtual ~FileStream() {}
190 
191     /* Please see man pages for details
192 
193 
194 
195 
196 
197 
198 
199 
200 
201 
202 
203     */
Read(void * buffer,size_t size)204     virtual s32 Read(void* buffer, size_t size) { return detail::FileBase::Read(buffer, size); }
205 
206     /* Please see man pages for details
207 
208 
209 
210 
211 
212 
213 
214 
215 
216 
217 
218 
219     */
TryRead(s32 * pOut,void * buffer,size_t size)220     virtual Result TryRead(s32* pOut, void* buffer, size_t size) { return detail::FileBase::TryRead(pOut, buffer, size); }
221 
222     /* Please see man pages for details
223 
224 
225 
226 
227 
228 
229 
230 
231 
232 
233 
234 
235 
236 
237 
238 
239     */
240     virtual s32 Write(const void* buffer, size_t size, bool flush=true) { return detail::FileBase::Write(buffer, size, flush); }
241 
242     /* Please see man pages for details
243 
244 
245 
246 
247 
248 
249 
250 
251 
252 
253 
254 
255 
256 
257 
258 
259 
260     */
261     virtual Result TryWrite(s32* pOut, const void* buffer, size_t size, bool flush=true) { return detail::FileBase::TryWrite(pOut, buffer, size, flush); }
262 
263     /* Please see man pages for details
264 
265 
266 
267 
268 
269 
270     */
Seek(s64 position,PositionBase base)271     virtual void Seek(s64 position, PositionBase base) { detail::FileBase::Seek(position, base); }
272 
273     /* Please see man pages for details
274 
275 
276 
277 
278 
279 
280 
281 
282     */
TrySeek(s64 position,PositionBase base)283     virtual Result TrySeek(s64 position, PositionBase base) { return detail::FileBase::TrySeek(position, base); }
284 
285     /* Please see man pages for details
286 
287 
288 
289     */
GetPosition()290     virtual s64 GetPosition() const { return detail::FileBase::GetPosition(); }
291 
292     /* Please see man pages for details
293 
294 
295 
296 
297 
298     */
TryGetPosition(s64 * pOut)299     virtual Result TryGetPosition(s64* pOut) const { return detail::FileBase::TryGetPosition(pOut); }
300 
301     /* Please see man pages for details
302 
303 
304 
305     */
SetPosition(s64 position)306     virtual void SetPosition(s64 position) { detail::FileBase::SetPosition(position); }
307 
308     /* Please see man pages for details
309 
310 
311 
312 
313 
314     */
TrySetPosition(s64 position)315     virtual Result TrySetPosition(s64 position) { return detail::FileBase::TrySetPosition(position); }
316 
317     /* Please see man pages for details
318 
319 
320 
321     */
GetSize()322     virtual s64 GetSize() const { return detail::FileBase::GetSize(); }
323 
324     /* Please see man pages for details
325 
326 
327 
328 
329 
330     */
TryGetSize(s64 * pOut)331     virtual Result TryGetSize(s64* pOut) const { return detail::FileBase::TryGetSize(pOut); }
332 
333     /* Please see man pages for details
334 
335 
336 
337      */
SetSize(s64 size)338     virtual void SetSize(s64 size) { detail::FileBase::SetSize(size); }
339 
340     /* Please see man pages for details
341 
342 
343 
344 
345 
346      */
TrySetSize(s64 size)347     virtual Result TrySetSize(s64 size) { return detail::FileBase::TrySetSize(size); }
348 
349     /* Please see man pages for details
350 
351      */
Flush()352     virtual void Flush() { detail::FileBase::Flush(); }
353 
354     /* Please see man pages for details
355 
356 
357 
358      */
TryFlush()359     virtual Result TryFlush() { return detail::FileBase::TryFlush(); }
360 };
361 
362 }}
363 
364 #endif
365