aboutsummaryrefslogtreecommitdiff
path: root/common/file.cpp
blob: ba94cb285a27932e80584d10dbabbc3557074f93 (plain)
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
/* 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/archive.h"
#include "common/file.h"
#include "common/fs.h"
#include "common/util.h"
#include "common/system.h"

namespace Common {

static Common::SearchSet *s_searchSet = 0;


void File::addDefaultDirectory(const String &directory) {
	FilesystemNode dir(directory);
	addDefaultDirectoryRecursive(dir, 1);
}

void File::addDefaultDirectoryRecursive(const String &directory, int level) {
	FilesystemNode dir(directory);
	addDefaultDirectoryRecursive(dir, level);
}

void File::addDefaultDirectory(const FilesystemNode &directory) {
	addDefaultDirectoryRecursive(directory, 1);
}

void File::addDefaultDirectoryRecursive(const FilesystemNode &dir, int level) {
	if (level <= 0 || !dir.exists() || !dir.isDirectory())
		return;

	if (!s_searchSet) {
		s_searchSet = new Common::SearchSet();
		g_system->addSysArchivesToSearchSet(*s_searchSet);
	}

	Common::ArchivePtr dataArchive(new Common::FSDirectory(dir, level));
	s_searchSet->add(dir.getPath(), dataArchive, 1);
}

void File::resetDefaultDirectories() {
	delete s_searchSet;
	s_searchSet = 0;
}

File::File()
	: _handle(0) {
}

File::~File() {
	close();
}


bool File::open(const String &filename) {
	assert(!filename.empty());
	assert(!_handle);

	_name.clear();
	clearIOFailed();

	if (s_searchSet && s_searchSet->hasFile(filename)) {
		debug(3, "Opening hashed: %s", filename.c_str());
		_handle = s_searchSet->openFile(filename);
	} else if (s_searchSet && s_searchSet->hasFile(filename + ".")) {
		// WORKAROUND: Bug #1458388: "SIMON1: Game Detection fails"
		// sometimes instead of "GAMEPC" we get "GAMEPC." (note trailing dot)
		debug(3, "Opening hashed: %s.", filename.c_str());
		_handle = s_searchSet->openFile(filename);
	} else {
		// Last resort: try the current directory
		FilesystemNode file(filename);
		if (file.exists() && !file.isDirectory())
			_handle = file.openForReading();
	}
	
	if (_handle == NULL)
		debug(2, "File %s not opened", filename.c_str());
	else
		_name = filename;

	return _handle != NULL;
}

bool File::open(const FilesystemNode &node) {

	if (!node.exists()) {
		warning("File::open: Trying to open a FilesystemNode which does not exist");
		return false;
	} else if (node.isDirectory()) {
		warning("File::open: Trying to open a FilesystemNode which is a directory");
		return false;
	} /*else if (!node.isReadable() && mode == kFileReadMode) {
		warning("File::open: Trying to open an unreadable FilesystemNode object for reading");
		return false;
	} else if (!node.isWritable() && mode == kFileWriteMode) {
		warning("File::open: Trying to open an unwritable FilesystemNode object for writing");
		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();

	_handle = node.openForReading();

	if (_handle == NULL)
		debug(2, "File %s not found", filename.c_str());
	else
		_name = filename;

	return _handle != NULL;
}

bool File::exists(const String &filename) {
	if (s_searchSet && s_searchSet->hasFile(filename)) {
		return true;
	} else if (s_searchSet && s_searchSet->hasFile(filename + ".")) {
		// WORKAROUND: Bug #1458388: "SIMON1: Game Detection fails"
		// sometimes instead of "GAMEPC" we get "GAMEPC." (note trailing dot)
		return true;
	} else {
		// Last resort: try the current directory
		FilesystemNode file(filename);
		if (file.exists() && !file.isDirectory())
			return true;
	}
	
	return false;
}

void File::close() {
	delete _handle;
	_handle = NULL;
}

bool File::isOpen() const {
	return _handle != NULL;
}

bool File::ioFailed() const {
	// TODO/FIXME: Just use ferror() here?
	return !_handle || _handle->ioFailed();
}

void File::clearIOFailed() {
	if (_handle)
		_handle->clearIOFailed();
}

bool File::eos() const {
	assert(_handle);
	return _handle->eos();
}

uint32 File::pos() const {
	assert(_handle);
	return _handle->pos();
}

uint32 File::size() const {
	assert(_handle);
	return _handle->size();
}

void File::seek(int32 offs, int whence) {
	assert(_handle);
	_handle->seek(offs, whence);
}

uint32 File::read(void *ptr, uint32 len) {
	assert(_handle);
	return _handle->read(ptr, len);
}


DumpFile::DumpFile() : _handle(0) {
}

DumpFile::~DumpFile() {
	close();
}

bool DumpFile::open(const String &filename) {
	assert(!filename.empty());
	assert(!_handle);

	FilesystemNode node(filename);
	return open(node);
}

bool DumpFile::open(const FilesystemNode &node) {
	assert(!_handle);

	if (node.isDirectory()) {
		warning("File::open: Trying to open a FilesystemNode which is a directory");
		return false;
	} /*else if (!node.isReadable() && mode == kFileReadMode) {
		warning("File::open: Trying to open an unreadable FilesystemNode object for reading");
		return false;
	} else if (!node.isWritable() && mode == kFileWriteMode) {
		warning("File::open: Trying to open an unwritable FilesystemNode object for writing");
		return false;
	}*/

	_handle = node.openForWriting();

	if (_handle == NULL)
		debug(2, "File %s not found", node.getName().c_str());

	return _handle != NULL;
}

void DumpFile::close() {
	delete _handle;
	_handle = NULL;
}

bool DumpFile::isOpen() const {
	return _handle != NULL;
}

bool DumpFile::ioFailed() const {
	assert(_handle);
	return _handle->ioFailed();
}

void DumpFile::clearIOFailed() {
	assert(_handle);
	_handle->clearIOFailed();
}

uint32 DumpFile::write(const void *ptr, uint32 len) {
	assert(_handle);
	return _handle->write(ptr, len);
}

void DumpFile::flush() {
	assert(_handle);
	_handle->flush();
}

}	// End of namespace Common