1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     hio_HostFile.h
4 
5   Copyright (C)2009-2012 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: 46347 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_HIO_CTR_HIO_HOSTFILE_H_
17 #define NN_HIO_CTR_HIO_HOSTFILE_H_
18 #ifdef  NN_SWITCH_ENABLE_HOST_IO
19 
20 /* Please see man pages for details
21 
22 
23 
24 
25 */
26 
27 #include <nn/types.h>
28 
29 namespace nn {
30 namespace hio {
31 namespace CTR {
32 
33     class HostSystemChannel;
34 
35 
36     /* Please see man pages for details
37 
38 
39     */
40     class HostFile
41     {
42     public:
43         /* Please see man pages for details
44 
45 
46         */
47         enum SeekType
48         {
49             SEEK_TYPE_SET,          //
50             SEEK_TYPE_CURRENT,      //
51             SEEK_TYPE_END           //
52         };
53 
54         /* Please see man pages for details
55 
56 
57         */
58         enum AccessMode
59         {
60             ACCESS_MODE_READ        = (1u << 31),                           //
61             ACCESS_MODE_WRITE       = (1u << 30),                           //
62             ACCESS_MODE_READ_WRITE  = (ACCESS_MODE_READ|ACCESS_MODE_WRITE)  //
63         };
64 
65 
66         /* Please see man pages for details
67 
68 
69         */
70         enum OpenDisp
71         {
72             OPEN_DISP_CREATE_NEW        = 1,    //
73             OPEN_DISP_CREATE_ALWAYS     = 2,    //
74             OPEN_DISP_OPEN_EXISTING     = 3,    //
75             OPEN_DISP_OPEN_ALWAYS       = 4     //
76         };
77 
78     private:
79         int                 m_Fd;
80 
81     public:
82         /* Please see man pages for details
83 
84 
85         */
HostFile()86         HostFile() : m_Fd(-1) {}
87 
88         /* Please see man pages for details
89 
90 
91         */
~HostFile()92         ~HostFile()
93         {
94             if( m_Fd >= 0 )
95             {
96                 Close();
97             }
98         }
99 
100         /* Please see man pages for details
101 
102 
103 
104 
105 
106 
107 
108 
109 
110 
111 
112 
113 
114         */
115         Result Open(const char* path, bit32 accessMode, OpenDisp disp);
116 
117 
118         /* Please see man pages for details
119 
120 
121 
122 
123 
124 
125 
126 
127 
128 
129 
130 
131 
132 
133         */
134         Result Open(const wchar_t* path, bit32 accessMode, OpenDisp disp);
135 
136         /* Please see man pages for details
137 
138 
139 
140 
141         */
142         Result Close();
143 
144         /* Please see man pages for details
145 
146 
147 
148 
149 
150 
151 
152 
153 
154 
155 
156 
157         */
158         Result Read(size_t* pRead, void* buf, size_t size);
159 
160         /* Please see man pages for details
161 
162 
163 
164 
165 
166 
167 
168 
169 
170 
171 
172         */
Read(void * buf,size_t size)173         s32 Read(void* buf, size_t size)
174         {
175             size_t read;
176             return Read(&read, buf, size).IsFailure() ? -1: static_cast<s32>(read);
177         }
178 
179         /* Please see man pages for details
180 
181 
182 
183 
184 
185 
186 
187 
188 
189 
190 
191 
192         */
193         Result Write(size_t* pWritten, const void* buf, size_t size);
194 
195         /* Please see man pages for details
196 
197 
198 
199 
200 
201 
202 
203 
204 
205 
206 
207         */
Write(const void * buf,size_t size)208         s32 Write(const void* buf, size_t size)
209         {
210             size_t written;
211             return Write(&written, buf, size).IsFailure() ? -1: static_cast<s32>(written);
212         }
213 
214         /* Please see man pages for details
215 
216 
217 
218 
219 
220 
221 
222 
223 
224 
225 
226 
227         */
228         Result Seek(s64* pPosition, s64 offset, SeekType type);
229 
230         /* Please see man pages for details
231 
232 
233 
234 
235 
236 
237 
238 
239 
240 
241 
242         */
Seek(s64 offset,SeekType type)243         s64 Seek(s64 offset, SeekType type)
244         {
245             s64 pos;
246             return Seek(&pos, offset, type).IsFailure() ? -1: pos;
247         }
248 
249         /* Please see man pages for details
250 
251 
252 
253 
254 
255         */
256         Result SetSize(s64 size);
257 
258 
259         /* Please see man pages for details
260 
261 
262 
263 
264 
265 
266 
267 
268 
269 
270         */
271         Result Exists(bool *exist, const char* path);
272 
273         /* Please see man pages for details
274 
275 
276 
277 
278 
279 
280 
281 
282 
283 
284 
285 
286         */
287         Result Exists(bool *exist, const wchar_t* path);
288     };
289 
290 }
291 }
292 }
293 
294 
295 #endif  // ifdef NN_SWITCH_ENABLE_HOST_IO
296 #endif  // ifndef NN_HIO_CTR_HIO_HOSTFILE_H_
297