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
|
/* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef AGI_LOADER_H
#define AGI_LOADER_H
namespace Agi {
class AgiLoader {
public:
AgiLoader(AgiEngine *vm) : _vm(vm) {}
virtual ~AgiLoader() {}
/**
* Performs one-time initializations, such as locating files
* with dynamic names.
*/
virtual void init() {}
/**
* Loads all AGI directory entries from disk and and populates
* the AgiDir arrays in AgiGame with them.
*/
virtual int loadDirs() = 0;
/**
* Loads a volume resource from disk.
*/
virtual uint8 *loadVolumeResource(AgiDir *agid) = 0;
/**
* Loads AgiEngine::_objects from disk.
*/
virtual int loadObjects() = 0;
/**
* Loads AgiBase::_words from disk.
*/
virtual int loadWords() = 0;
protected:
AgiEngine *_vm;
typedef Common::HashMap<Common::Path, Common::FSNode, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo> FileMap;
static void getPotentialDiskImages(
const char * const *imageExtensions,
size_t imageExtensionCount,
Common::Array<Common::Path> &imageFiles,
FileMap &fileMap);
};
struct AgiDiskVolume {
uint32 disk;
uint32 offset;
AgiDiskVolume() : disk(_EMPTY), offset(0) {}
AgiDiskVolume(uint32 d, uint32 o) : disk(d), offset(o) {}
};
/**
* Apple II version of the format for LOGDIR, VIEWDIR, etc.
* See AgiLoader_A2::loadDir for more details.
*/
enum A2DirVersion {
A2DirVersionOld, // 4 bits for volume, 8 for track
A2DirVersionNew, // 5 bits for volume, 7 for track
};
class AgiLoader_A2 : public AgiLoader {
public:
AgiLoader_A2(AgiEngine *vm) : AgiLoader(vm) {}
~AgiLoader_A2() override;
void init() override;
int loadDirs() override;
uint8 *loadVolumeResource(AgiDir *agid) override;
int loadObjects() override;
int loadWords() override;
private:
Common::Array<Common::SeekableReadStream *> _disks;
Common::Array<AgiDiskVolume> _volumes;
AgiDir _logDir;
AgiDir _picDir;
AgiDir _viewDir;
AgiDir _soundDir;
AgiDir _objects;
AgiDir _words;
int readDiskOne(Common::SeekableReadStream &stream, Common::Array<uint32> &volumeMap);
static bool readInitDir(Common::SeekableReadStream &stream, byte index, AgiDir &agid);
static bool readDir(Common::SeekableReadStream &stream, int position, AgiDir &agid);
static bool readVolumeMap(Common::SeekableReadStream &stream, uint32 position, uint32 bufferLength, Common::Array<uint32> &volumeMap);
A2DirVersion detectDirVersion(Common::SeekableReadStream &stream) const;
static bool loadDir(AgiDir *dir, Common::SeekableReadStream &disk, uint32 dirOffset, uint32 dirLength, A2DirVersion dirVersion);
};
class AgiLoader_v1 : public AgiLoader {
public:
AgiLoader_v1(AgiEngine *vm) : AgiLoader(vm) {}
void init() override;
int loadDirs() override;
uint8 *loadVolumeResource(AgiDir *agid) override;
int loadObjects() override;
int loadWords() override;
private:
Common::Array<Common::String> _imageFiles;
Common::Array<AgiDiskVolume> _volumes;
AgiDir _logDir;
AgiDir _picDir;
AgiDir _viewDir;
AgiDir _soundDir;
AgiDir _objects;
AgiDir _words;
bool readDiskOneV1(Common::SeekableReadStream &stream);
bool readDiskOneV2001(Common::SeekableReadStream &stream, int &vol0Offset);
static bool readInitDirV1(Common::SeekableReadStream &stream, byte index, AgiDir &agid);
static bool readInitDirV2001(Common::SeekableReadStream &stream, byte index, AgiDir &agid);
bool loadDir(AgiDir *dir, Common::File &disk, uint32 dirOffset, uint32 dirLength);
};
class AgiLoader_v2 : public AgiLoader {
private:
bool _hasV3VolumeFormat;
int loadDir(AgiDir *agid, const char *fname);
bool detectV3VolumeFormat();
public:
AgiLoader_v2(AgiEngine *vm) : _hasV3VolumeFormat(false), AgiLoader(vm) {}
int loadDirs() override;
uint8 *loadVolumeResource(AgiDir *agid) override;
int loadObjects() override;
int loadWords() override;
};
class AgiLoader_v3 : public AgiLoader {
private:
Common::String _name; /**< prefix in directory and/or volume file names (`GR' for goldrush) */
int loadDir(AgiDir *agid, Common::File *fp, uint32 offs, uint32 len);
public:
AgiLoader_v3(AgiEngine *vm) : AgiLoader(vm) {}
void init() override;
int loadDirs() override;
uint8 *loadVolumeResource(AgiDir *agid) override;
int loadObjects() override;
int loadWords() override;
};
class GalLoader : public AgiLoader {
public:
GalLoader(AgiEngine *vm) : _dirOffset(0), AgiLoader(vm) {}
void init() override;
int loadDirs() override;
uint8 *loadVolumeResource(AgiDir *agid) override;
int loadObjects() override;
int loadWords() override;
private:
Common::String _imageFile;
int _dirOffset;
static bool isDirectory(Common::SeekableReadStream &stream, uint32 dirOffset);
static uint32 readDirectoryEntry(Common::SeekableReadStream &stream, uint32 *sectorCount);
};
class GalLoader_A2 : public AgiLoader {
public:
GalLoader_A2(AgiEngine *vm) : AgiLoader(vm) {}
~GalLoader_A2();
void init() override;
int loadDirs() override;
uint8 *loadVolumeResource(AgiDir *agid) override;
int loadObjects() override;
int loadWords() override;
private:
Common::Array<Common::SeekableReadStream *> _disks;
static bool readDiskOne(Common::SeekableReadStream &disk, AgiDir *logicDir);
static bool readDirectoryEntry(Common::SeekableReadStream &stream, AgiDir &dirEntry);
static bool validateDisk(Common::SeekableReadStream &disk, byte diskIndex, AgiDir *logicDir);
static bool loadDir(AgiDir *dir, Common::SeekableReadStream &disk, uint32 dirOffset, uint32 dirCount);
};
} // End of namespace Agi
#endif /* AGI_LOADER_H */
|
