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
|
/* 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 XEEN_FILES_H
#define XEEN_FILES_H
#include "common/scummsys.h"
#include "common/array.h"
#include "common/file.h"
#include "common/serializer.h"
#include "common/str-array.h"
#include "graphics/surface.h"
namespace Xeen {
enum ArchiveType {
ANY_ARCHIVE = -1, GAME_ARCHIVE = 0, ALTSIDE_ARCHIVE = 1,
INTRO_ARCHIVE = 2
};
class XeenEngine;
class CCArchive;
class File;
#define SYNC_AS(SUFFIX,STREAM,TYPE,SIZE) \
template<typename T> \
void syncAs ## SUFFIX(T &val, Version minVersion = 0, Version maxVersion = kLastVersion) { \
if (_version < minVersion || _version > maxVersion) \
return; \
if (_loadStream) \
val = static_cast<TYPE>(_loadStream->read ## STREAM()); \
else { \
TYPE tmp = (TYPE)val; \
_saveStream->write ## STREAM(tmp); \
} \
_bytesSynced += SIZE; \
}
/*
* Main resource manager
*/
class FileManager {
friend class File;
private:
static CCArchive *_archives[3];
public:
bool _isDarkCc;
public:
/**
* Instantiates the resource manager
*/
FileManager(XeenEngine *vm);
/**
* Set which game side files to use
*/
void setGameCc(bool isDarkCc);
};
/**
* Derived file class
*/
class File : public Common::File {
public:
static ArchiveType _currentArchive;
/**
* Sets which archive is used by default
*/
static void setCurrentArchive(ArchiveType arcType) { _currentArchive = arcType; }
public:
File() : Common::File() {}
File(const Common::String &filename);
File(const Common::String &filename, ArchiveType archiveType);
File(const Common::String &filename, Common::Archive &archive);
virtual ~File() {}
/**
* Opens the given file, throwing an error if it can't be opened
*/
virtual bool open(const Common::String &filename);
/**
* Opens the given file, throwing an error if it can't be opened
*/
virtual bool open(const Common::String &filename, ArchiveType archiveType);
/**
* Opens the given file, throwing an error if it can't be opened
*/
virtual bool open(const Common::String &filename, Common::Archive &archive);
/**
* Opens the given file
*/
virtual bool open(const Common::FSNode &node) {
return Common::File::open(node);
}
/**
* Opens the given file
*/
virtual bool open(SeekableReadStream *stream, const Common::String &name) {
return Common::File::open(stream, name);
}
Common::String readString();
};
class StringArray : public Common::StringArray {
public:
StringArray() {}
StringArray(const Common::String &name) { load(name); }
/**
* Loads a string array from the specified file
*/
void load(const Common::String &name);
/**
* Loads a string array from the specified file
*/
void load(const Common::String &name, ArchiveType archiveType);
};
class XeenSerializer : public Common::Serializer {
private:
Common::SeekableReadStream *_in;
public:
XeenSerializer(Common::SeekableReadStream *in, Common::WriteStream *out) :
Common::Serializer(in, out), _in(in) {}
SYNC_AS(Sint8, Byte, int8, 1)
bool finished() const { return _in != nullptr && _in->pos() >= _in->size(); }
};
/**
* Details of a single entry in a CC file index
*/
struct CCEntry {
uint16 _id;
uint32 _offset;
uint16 _size;
CCEntry() : _id(0), _offset(0), _size(0) {}
CCEntry(uint16 id, uint32 offset, uint32 size)
: _id(id), _offset(offset), _size(size) {
}
};
/**
* Base Xeen CC file implementation
*/
class BaseCCArchive : public Common::Archive {
protected:
Common::Array<CCEntry> _index;
/**
* Load the index of a given CC file
*/
void loadIndex(Common::SeekableReadStream *stream);
/**
* Given a resource name, returns whether an entry exists, and returns
* the header index data for that entry
*/
virtual bool getHeaderEntry(const Common::String &resourceName, CCEntry &ccEntry) const;
public:
/**
* Hash a given filename to produce the Id that represents it
*/
static uint16 convertNameToId(const Common::String &resourceName);
public:
BaseCCArchive() {}
// Archive implementation
virtual bool hasFile(const Common::String &name) const;
virtual int listMembers(Common::ArchiveMemberList &list) const;
virtual const Common::ArchiveMemberPtr getMember(const Common::String &name) const;
};
/**
* Xeen CC file implementation
*/
class CCArchive : public BaseCCArchive {
private:
Common::String _filename;
Common::String _prefix;
bool _encoded;
protected:
virtual bool getHeaderEntry(const Common::String &resourceName, CCEntry &ccEntry) const;
public:
CCArchive(const Common::String &filename, bool encoded);
CCArchive(const Common::String &filename, const Common::String &prefix, bool encoded);
virtual ~CCArchive();
// Archive implementation
virtual Common::SeekableReadStream *createReadStreamForMember(const Common::String &name) const;
};
} // End of namespace Xeen
#endif /* XEEN_FILES_H */
|
