1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     hio_HostFile.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: 27284 $
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 
101         /* Please see man pages for details
102 
103 
104 
105 
106 
107 
108 
109 
110 
111         */
112         Result Open(const char* path, bit32 accessMode, OpenDisp disp);
113 
114         /* Please see man pages for details
115 
116 
117 
118 
119 
120 
121 
122 
123 
124         */
125         Result Open(const wchar_t* path, bit32 accessMode, OpenDisp disp);
126 
127         /* Please see man pages for details
128 
129 
130 
131 
132         */
133         Result Close();
134 
135         /* Please see man pages for details
136 
137 
138 
139 
140 
141 
142 
143 
144 
145         */
146         Result Read(size_t* pRead, void* buf, size_t size);
147 
148         /* Please see man pages for details
149 
150 
151 
152 
153 
154 
155 
156 
157         */
Read(void * buf,size_t size)158         s32 Read(void* buf, size_t size)
159         {
160             size_t read;
161             return Read(&read, buf, size).IsFailure() ? -1: static_cast<s32>(read);
162         }
163 
164         /* Please see man pages for details
165 
166 
167 
168 
169 
170 
171 
172 
173 
174         */
175         Result Write(size_t* pWritten, const void* buf, size_t size);
176 
177         /* Please see man pages for details
178 
179 
180 
181 
182 
183 
184 
185 
186         */
Write(const void * buf,size_t size)187         s32 Write(const void* buf, size_t size)
188         {
189             size_t written;
190             return Write(&written, buf, size).IsFailure() ? -1: static_cast<s32>(written);
191         }
192 
193         /* Please see man pages for details
194 
195 
196 
197 
198 
199 
200 
201 
202 
203         */
204         Result Seek(s64* pPosition, s64 offset, SeekType type);
205 
206         /* Please see man pages for details
207 
208 
209 
210 
211 
212 
213 
214 
215         */
Seek(s64 offset,SeekType type)216         s64 Seek(s64 offset, SeekType type)
217         {
218             s64 pos;
219             return Seek(&pos, offset, type).IsFailure() ? -1: pos;
220         }
221 
222         /* Please see man pages for details
223 
224 
225 
226 
227 
228         */
229         Result SetSize(s64 size);
230 
231         /* Please see man pages for details
232 
233 
234 
235 
236 
237 
238         */
239         Result IsExist(bool *exist, const char* path);
240 
241         /* Please see man pages for details
242 
243 
244 
245 
246 
247 
248         */
249         Result IsExist(bool *exist, const wchar_t* path);
250     };
251 
252 }
253 }
254 }
255 
256 
257 #endif  // ifdef NN_SWITCH_ENABLE_HOST_IO
258 #endif  // ifndef NN_HIO_CTR_HIO_HOSTFILE_H_
259