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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef _DS_FS_H
#define _DS_FS_H
#include "common/fs.h"
#include "common/stream.h"
#include "backends/fs/abstract-fs.h"
#include "zipreader.h"
#include "fat/gba_nds_fat.h"
namespace DS {
/**
* Implementation of the ScummVM file system API.
* This class is used when a Flash cart is in use.
*
* Parts of this class are documented in the base interface class, AbstractFSNode.
*/
class DSFileSystemNode : public AbstractFSNode {
protected:
static ZipFile *_zipFile;
Common::String _displayName;
Common::String _path;
bool _isDirectory;
bool _isValid;
public:
/**
* Creates a DSFilesystemNode with the root node as path.
*/
DSFileSystemNode();
/**
* Creates a DSFilesystemNode for a given path.
*
* @param path String with the path the new node should point to.
*/
DSFileSystemNode(const Common::String &path);
/**
* Creates a DSFilesystemNode for a given path.
*
* @param path String with the path the new node should point to.
* @param path true if path is a directory, false otherwise.
*/
DSFileSystemNode(const Common::String& path, bool isDir);
/**
* Copy constructor.
*/
DSFileSystemNode(const DSFileSystemNode *node);
virtual bool exists() const { return true; } //FIXME: this is just a stub
virtual Common::String getDisplayName() const { return _displayName; }
virtual Common::String getName() const { return _displayName; }
virtual Common::String getPath() const { return _path; }
virtual bool isDirectory() const { return _isDirectory; }
virtual bool isReadable() const { return true; } //FIXME: this is just a stub
virtual bool isWritable() const { return true; } //FIXME: this is just a stub
/**
* Returns a copy of this node.
*/
virtual AbstractFSNode *clone() const { return new DSFileSystemNode(this); }
virtual AbstractFSNode *getChild(const Common::String& name) const;
virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const;
virtual AbstractFSNode *getParent() const;
virtual Common::SeekableReadStream *createReadStream();
virtual Common::WriteStream *createWriteStream();
virtual bool create(bool isDirectoryFlag);
/**
* Returns the zip file this node points to.
* TODO: check this documentation.
*/
static ZipFile *getZip() { return _zipFile; }
};
/**
* Implementation of the ScummVM file system API.
* This class is used when the GBAMP (GBA Movie Player) is used with a CompactFlash card.
*
* Parts of this class are documented in the base interface class, AbstractFSNode.
*/
class GBAMPFileSystemNode : public AbstractFSNode {
protected:
Common::String _displayName;
Common::String _path;
bool _isDirectory;
bool _isValid;
public:
/**
* Creates a GBAMPFilesystemNode with the root node as path.
*/
GBAMPFileSystemNode();
/**
* Creates a GBAMPFilesystemNode for a given path.
*
* @param path String with the path the new node should point to.
*/
GBAMPFileSystemNode(const Common::String &path);
/**
* Creates a DSFilesystemNode for a given path.
*
* @param path String with the path the new node should point to.
* @param path true if path is a directory, false otherwise.
*/
GBAMPFileSystemNode(const Common::String &path, bool isDirectoryFlag);
/**
* Copy constructor.
*/
GBAMPFileSystemNode(const GBAMPFileSystemNode *node);
virtual bool exists() const { return _isValid || _isDirectory; }
virtual Common::String getDisplayName() const { return _displayName; }
virtual Common::String getName() const { return _displayName; }
virtual Common::String getPath() const { return _path; }
virtual bool isDirectory() const { return _isDirectory; }
virtual bool isReadable() const { return true; } //FIXME: this is just a stub
virtual bool isWritable() const { return true; } //FIXME: this is just a stub
/**
* Returns a copy of this node.
*/
virtual AbstractFSNode *clone() const { return new GBAMPFileSystemNode(this); }
virtual AbstractFSNode *getChild(const Common::String& name) const;
virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const;
virtual AbstractFSNode *getParent() const;
virtual Common::SeekableReadStream *createReadStream();
virtual Common::WriteStream *createWriteStream();
virtual bool create(bool isDirectoryFlag);
};
struct fileHandle {
int pos;
bool used;
char *data;
int size;
};
class DSFileStream : public Common::SeekableReadStream, public Common::WriteStream, public Common::NonCopyable {
protected:
/** File handle to the actual file. */
void *_handle;
public:
/**
* Given a path, invokes fopen on that path and wrap the result in a
* StdioStream instance.
*/
static DSFileStream *makeFromPath(const Common::String &path, bool writeMode);
DSFileStream(void *handle);
virtual ~DSFileStream();
bool err() const;
void clearErr();
bool eos() const;
virtual uint32 write(const void *dataPtr, uint32 dataSize);
virtual bool flush();
virtual int32 pos() const;
virtual int32 size() const;
bool seek(int32 offs, int whence = SEEK_SET);
uint32 read(void *dataPtr, uint32 dataSize);
};
// FIXME/TODO: Get rid of the following hacks. Top priority: Get rid of
// the 'FILE' (re)definition. Simply calling it STD_FILE or so wold already
// suffice (need to adjust affected code, of course).
// Once the OSystem::logMessage() patch is in SVN, we should also be
// able to get rid of stderr, stdout, stdin.
// Moreover, the std_FOO() functions could then be moved to a private
// header, or even completely merged into DSFileStream, and all other
// DS code switch to use that.
#undef stderr
#undef stdout
#undef stdin
#define stdout ((DS::fileHandle *) -1)
#define stderr ((DS::fileHandle *) -2)
#define stdin ((DS::fileHandle *) -3)
#define FILE DS::fileHandle
// Please do not remove any of these prototypes that appear not to be required.
FILE* std_fopen(const char *name, const char *mode);
void std_fclose(FILE *handle);
size_t std_fread(void *ptr, size_t size, size_t numItems, FILE *handle);
size_t std_fwrite(const void *ptr, size_t size, size_t numItems, FILE *handle);
bool std_feof(FILE *handle);
long int std_ftell(FILE *handle);
int std_fseek(FILE *handle, long int offset, int whence);
void std_clearerr(FILE *handle);
int std_fflush(FILE *handle);
int std_ferror(FILE *handle);
} // End of namespace DS
#endif //_DS_FS_H
|
