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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
|
/* 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.
*
* $URL$
* $Id$
*
*/
#include "common/file.h"
#include "common/fs.h"
#include "common/hashmap.h"
#include "common/util.h"
#include "common/hash-str.h"
#ifdef MACOSX
#include "CoreFoundation/CoreFoundation.h"
#endif
#ifdef __PLAYSTATION2__
// for those replaced fopen/fread/etc functions
typedef unsigned long uint64;
typedef signed long int64;
#include "backends/platform/ps2/fileio.h"
#define fopen(a, b) ps2_fopen(a, b)
#define fclose(a) ps2_fclose(a)
#define fseek(a, b, c) ps2_fseek(a, b, c)
#define ftell(a) ps2_ftell(a)
#define feof(a) ps2_feof(a)
#define fread(a, b, c, d) ps2_fread(a, b, c, d)
#define fwrite(a, b, c, d) ps2_fwrite(a, b, c, d)
//#define fprintf ps2_fprintf // used in common/util.cpp
//#define fflush(a) ps2_fflush(a) // used in common/util.cpp
//#define fgetc(a) ps2_fgetc(a) // not used
//#define fgets(a, b, c) ps2_fgets(a, b, c) // not used
//#define fputc(a, b) ps2_fputc(a, b) // not used
//#define fputs(a, b) ps2_fputs(a, b) // not used
//#define fsize(a) ps2_fsize(a) // not used -- and it is not a standard function either
#endif
#ifdef __DS__
// These functions replease the standard library functions of the same name.
// As this header is included after the standard one, I have the chance to #define
// all of these to my own code.
//
// A #define is the only way, as redefinig the functions would cause linker errors.
// These functions need to be #undef'ed, as their original definition
// in devkitarm is done with #includes (ugh!)
#undef feof
#undef clearerr
//#undef getc
//#undef ferror
//void std_fprintf(FILE* handle, const char* fmt, ...); // used in common/util.cpp
//void std_fflush(FILE* handle); // used in common/util.cpp
//char* std_fgets(char* str, int size, FILE* file); // not used
//int std_getc(FILE* handle); // not used
//char* std_getcwd(char* dir, int dunno); // not used
//void std_cwd(char* dir); // not used
//int std_ferror(FILE* handle); // not used
// Only functions used in the ScummVM source have been defined here!
#define fopen(name, mode) DS::std_fopen(name, mode)
#define fclose(handle) DS::std_fclose(handle)
#define fread(ptr, size, items, file) DS::std_fread(ptr, size, items, file)
#define fwrite(ptr, size, items, file) DS::std_fwrite(ptr, size, items, file)
#define feof(handle) DS::std_feof(handle)
#define ftell(handle) DS::std_ftell(handle)
#define fseek(handle, offset, whence) DS::std_fseek(handle, offset, whence)
#define clearerr(handle) DS::std_clearerr(handle)
//#define printf(fmt, ...) consolePrintf(fmt, ##__VA_ARGS__)
//#define fprintf(file, fmt, ...) { char str[128]; sprintf(str, fmt, ##__VA_ARGS__); DS::std_fwrite(str, strlen(str), 1, file); }
//#define fflush(file) DS::std_fflush(file) // used in common/util.cpp
//#define fgets(str, size, file) DS::std_fgets(str, size, file) // not used
//#define getc(handle) DS::std_getc(handle) // not used
//#define getcwd(dir, dunno) DS::std_getcwd(dir, dunno) // not used
//#define ferror(handle) DS::std_ferror(handle) // not used
#endif
#ifdef __SYMBIAN32__
#undef feof
#undef clearerr
#define FILE void
FILE* symbian_fopen(const char* name, const char* mode);
void symbian_fclose(FILE* handle);
size_t symbian_fread(const void* ptr, size_t size, size_t numItems, FILE* handle);
size_t symbian_fwrite(const void* ptr, size_t size, size_t numItems, FILE* handle);
bool symbian_feof(FILE* handle);
long int symbian_ftell(FILE* handle);
int symbian_fseek(FILE* handle, long int offset, int whence);
void symbian_clearerr(FILE* handle);
// Only functions used in the ScummVM source have been defined here!
#define fopen(name, mode) symbian_fopen(name, mode)
#define fclose(handle) symbian_fclose(handle)
#define fread(ptr, size, items, file) symbian_fread(ptr, size, items, file)
#define fwrite(ptr, size, items, file) symbian_fwrite(ptr, size, items, file)
#define feof(handle) symbian_feof(handle)
#define ftell(handle) symbian_ftell(handle)
#define fseek(handle, offset, whence) symbian_fseek(handle, offset, whence)
#define clearerr(handle) symbian_clearerr(handle)
#endif
namespace Common {
typedef HashMap<String, int, CaseSensitiveString_Hash, CaseSensitiveString_EqualTo> StringIntMap;
// The following two objects could be turned into static members of class
// File. However, then we would be forced to #include hashmap in file.h
// which seems to be a high price just for a simple beautification...
static StringIntMap *_defaultDirectories;
static StringMap *_filesMap;
static FILE *fopenNoCase(const String &filename, const String &directory, const char *mode) {
FILE *file;
String buf(directory);
uint i;
#if !defined(__GP32__) && !defined(PALMOS_MODE)
// Add a trailing slash, if necessary.
if (!buf.empty()) {
const char c = buf.lastChar();
if (c != ':' && c != '/' && c != '\\')
buf += '/';
}
#endif
// Append the filename to the path string
const int offsetToFileName = buf.size();
buf += filename;
//
// Try to open the file normally
//
file = fopen(buf.c_str(), mode);
//
// Try again, with file name converted to upper case
//
if (!file) {
for (i = offsetToFileName; i < buf.size(); ++i) {
buf[i] = toupper(buf[i]);
}
file = fopen(buf.c_str(), mode);
}
//
// Try again, with file name converted to lower case
//
if (!file) {
for (i = offsetToFileName; i < buf.size(); ++i) {
buf[i] = tolower(buf[i]);
}
file = fopen(buf.c_str(), mode);
}
//
// Try again, with file name capitalized
//
if (!file) {
i = offsetToFileName;
buf[i] = toupper(buf[i]);
file = fopen(buf.c_str(), mode);
}
#ifdef __amigaos4__
//
// Work around for possibility that someone uses AmigaOS "newlib" build with SmartFileSystem (blocksize 512 bytes), leading
// to buffer size being only 512 bytes. "Clib2" sets the buffer size to 8KB, resulting smooth movie playback. This forces the buffer
// to be enough also when using "newlib" compile on SFS.
//
if (file) {
setvbuf(file, NULL, _IOFBF, 8192);
}
#endif
return file;
}
void File::addDefaultDirectory(const String &directory) {
FilesystemNode dir(directory);
addDefaultDirectoryRecursive(dir, 1);
}
void File::addDefaultDirectoryRecursive(const String &directory, int level, const String &prefix) {
FilesystemNode dir(directory);
addDefaultDirectoryRecursive(dir, level, prefix);
}
void File::addDefaultDirectory(const FilesystemNode &directory) {
addDefaultDirectoryRecursive(directory, 1);
}
void File::addDefaultDirectoryRecursive(const FilesystemNode &dir, int level, const String &prefix) {
if (level <= 0)
return;
FSList fslist;
if (!dir.getChildren(fslist, FilesystemNode::kListAll)) {
// Failed listing the contents of this node, so it is either not a
// directory, or just doesn't exist at all.
return;
}
if (!_defaultDirectories)
_defaultDirectories = new StringIntMap;
// Do not add directories multiple times, unless this time they are added
// with a bigger depth.
const String &directory(dir.getPath());
if (_defaultDirectories->contains(directory) && (*_defaultDirectories)[directory] >= level)
return;
(*_defaultDirectories)[directory] = level;
if (!_filesMap)
_filesMap = new StringMap;
for (FSList::const_iterator file = fslist.begin(); file != fslist.end(); ++file) {
if (file->isDirectory()) {
addDefaultDirectoryRecursive(file->getPath(), level - 1, prefix + file->getName() + "/");
} else {
String lfn(prefix);
lfn += file->getName();
lfn.toLowercase();
if (!_filesMap->contains(lfn)) {
(*_filesMap)[lfn] = file->getPath();
}
}
}
}
void File::resetDefaultDirectories() {
delete _defaultDirectories;
delete _filesMap;
_defaultDirectories = 0;
_filesMap = 0;
}
File::File()
: _handle(0), _ioFailed(false) {
}
//#define DEBUG_FILE_REFCOUNT
File::~File() {
#ifdef DEBUG_FILE_REFCOUNT
warning("File::~File on file '%s'", _name.c_str());
#endif
close();
}
bool File::open(const String &filename, AccessMode mode) {
assert(mode == kFileReadMode || mode == kFileWriteMode);
if (filename.empty()) {
error("File::open: No filename was specified");
}
if (_handle) {
error("File::open: This file object already is opened (%s), won't open '%s'", _name.c_str(), filename.c_str());
}
_name.clear();
clearIOFailed();
String fname(filename);
fname.toLowercase();
const char *modeStr = (mode == kFileReadMode) ? "rb" : "wb";
if (mode == kFileWriteMode) {
_handle = fopenNoCase(filename, "", modeStr);
} else if (_filesMap && _filesMap->contains(fname)) {
fname = (*_filesMap)[fname];
debug(3, "Opening hashed: %s", fname.c_str());
_handle = fopen(fname.c_str(), modeStr);
} else if (_filesMap && _filesMap->contains(fname + ".")) {
// WORKAROUND: Bug #1458388: "SIMON1: Game Detection fails"
// sometimes instead of "GAMEPC" we get "GAMEPC." (note trailing dot)
fname = (*_filesMap)[fname + "."];
debug(3, "Opening hashed: %s", fname.c_str());
_handle = fopen(fname.c_str(), modeStr);
} else {
if (_defaultDirectories) {
// Try all default directories
StringIntMap::const_iterator x(_defaultDirectories->begin());
for (; _handle == NULL && x != _defaultDirectories->end(); ++x) {
_handle = fopenNoCase(filename, x->_key, modeStr);
}
}
// Last resort: try the current directory
if (_handle == NULL)
_handle = fopenNoCase(filename, "", modeStr);
// Last last (really) resort: try looking inside the application bundle on Mac OS X for the lowercase file.
#ifdef MACOSX
if (!_handle) {
CFStringRef cfFileName = CFStringCreateWithBytes(NULL, (const UInt8 *)filename.c_str(), filename.size(), kCFStringEncodingASCII, false);
CFURLRef fileUrl = CFBundleCopyResourceURL(CFBundleGetMainBundle(), cfFileName, NULL, NULL);
if (fileUrl) {
UInt8 buf[256];
if (CFURLGetFileSystemRepresentation(fileUrl, false, (UInt8 *)buf, 256)) {
_handle = fopen((char *)buf, modeStr);
}
CFRelease(fileUrl);
}
CFRelease(cfFileName);
}
#endif
}
if (_handle == NULL) {
if (mode == kFileReadMode)
debug(2, "File %s not found", filename.c_str());
else
debug(2, "File %s not opened", filename.c_str());
return false;
}
_name = filename;
#ifdef DEBUG_FILE_REFCOUNT
warning("File::open on file '%s'", _name.c_str());
#endif
return true;
}
bool File::open(const FilesystemNode &node, AccessMode mode) {
assert(mode == kFileReadMode || mode == kFileWriteMode);
if (!node.isValid()) {
warning("File::open: Trying to open an invalid FilesystemNode object");
return false;
} else if (node.isDirectory()) {
warning("File::open: Trying to open a FilesystemNode which is a directory");
return false;
}
String filename(node.getName());
if (_handle) {
error("File::open: This file object already is opened (%s), won't open '%s'", _name.c_str(), filename.c_str());
}
clearIOFailed();
_name.clear();
const char *modeStr = (mode == kFileReadMode) ? "rb" : "wb";
_handle = fopen(node.getPath().c_str(), modeStr);
if (_handle == NULL) {
if (mode == kFileReadMode)
debug(2, "File %s not found", filename.c_str());
else
debug(2, "File %s not opened", filename.c_str());
return false;
}
_name = filename;
#ifdef DEBUG_FILE_REFCOUNT
warning("File::open on file '%s'", _name.c_str());
#endif
return true;
}
bool File::exists(const String &filename) {
// First try to find the file it via a FilesystemNode (in case an absolute
// path was passed). But we only use this to filter out directories.
FilesystemNode file(filename);
// FIXME: can't use isValid() here since at the time of writing
// FilesystemNode is to be unable to find for example files
// added in extrapath
if (file.isDirectory())
return false;
// Next, try to locate the file by *opening* it in read mode. This has
// multiple effects:
// 1) It takes _filesMap and _defaultDirectories into consideration -> good
// 2) It returns true if and only if File::open is possible on the file -> good
// 3) If this method is misused, it could lead to an fopen call on a directory
// -> bad!
// 4) It also checks whether we can read the file. This is not 100%
// desirable; after all, even when we can't read it, the file is present.
// Since this method is often used to check whether a file should be
// re-created, that's not nice.
//
// TODO/FIXME: We should clarify the semantics of this method, and then
// maybe should introduce several new methods:
// fileExistsAndReadable
// fileExists
// fileExistsAtPath
// dirExists
// dirExistsAtPath
// or maybe only 1-2 methods which take some params :-).
File tmp;
return tmp.open(filename, kFileReadMode);
}
void File::close() {
if (_handle)
fclose((FILE *)_handle);
_handle = NULL;
}
bool File::isOpen() const {
return _handle != NULL;
}
bool File::ioFailed() const {
return _ioFailed != 0;
}
void File::clearIOFailed() {
_ioFailed = false;
}
bool File::eof() const {
if (_handle == NULL) {
error("File::eof: File is not open!");
return false;
}
return feof((FILE *)_handle) != 0;
}
uint32 File::pos() const {
if (_handle == NULL) {
error("File::pos: File is not open!");
return 0;
}
return ftell((FILE *)_handle);
}
uint32 File::size() const {
if (_handle == NULL) {
error("File::size: File is not open!");
return 0;
}
uint32 oldPos = ftell((FILE *)_handle);
fseek((FILE *)_handle, 0, SEEK_END);
uint32 length = ftell((FILE *)_handle);
fseek((FILE *)_handle, oldPos, SEEK_SET);
return length;
}
void File::seek(int32 offs, int whence) {
if (_handle == NULL) {
error("File::seek: File is not open!");
return;
}
if (fseek((FILE *)_handle, offs, whence) != 0)
clearerr((FILE *)_handle);
}
uint32 File::read(void *ptr, uint32 len) {
byte *ptr2 = (byte *)ptr;
uint32 real_len;
if (_handle == NULL) {
error("File::read: File is not open!");
return 0;
}
if (len == 0)
return 0;
real_len = fread(ptr2, 1, len, (FILE *)_handle);
if (real_len < len) {
_ioFailed = true;
}
return real_len;
}
uint32 File::write(const void *ptr, uint32 len) {
if (_handle == NULL) {
error("File::write: File is not open!");
return 0;
}
if (len == 0)
return 0;
if ((uint32)fwrite(ptr, 1, len, (FILE *)_handle) != len) {
_ioFailed = true;
}
return len;
}
} // End of namespace Common
|