-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathmacresman.h
More file actions
429 lines (355 loc) · 11.2 KB
/
macresman.h
File metadata and controls
429 lines (355 loc) · 11.2 KB
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
/* 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/>.
*
*/
/**
* @file
*/
#include "common/array.h"
#include "common/fs.h"
#include "common/rect.h"
#include "common/str.h"
#include "common/str-array.h"
#ifndef COMMON_MACRESMAN_H
#define COMMON_MACRESMAN_H
namespace Common {
/**
* @defgroup common_macresman Macintosh resource fork manager
* @ingroup common
*
* @brief API for Macintosh resource fork manager.
*
* @details Used in engines:
* - director
* - groovie
* - kyra
* - mohawk
* - mtropolis
* - pegasus
* - sci
* - scumm
* @{
*/
typedef Array<uint16> MacResIDArray;
typedef Array<uint32> MacResTagArray;
typedef bool (* ProgressUpdateCallback)(void *, int);
/**
* Class containing the raw data bytes for a Macintosh Finder Info data block.
*/
struct MacFinderInfoData {
byte data[16];
};
/**
* Class containing the raw data bytes for a Macintosh Extended Finder Info data block.
*/
struct MacFinderExtendedInfoData {
byte data[16];
};
/**
* Class containing Macintosh Finder Info.
*/
struct MacFinderInfo {
enum FinderFlags {
kFinderFlagAlias = (1 << 15),
kFinderFlagInvisible = (1 << 14),
kFinderFlagBundle = (1 << 13),
kFinderFlagNameLocked = (1 << 12),
kFinderFlagStationery = (1 << 11),
kFinderFlagCustomIcon = (1 << 10),
kFinderFlagInited = (1 << 8),
kFinderFlagNoInit = (1 << 7),
kFinderFlagShared = (1 << 6),
kFinderFlagColorBit2 = (1 << 3),
kFinderFlagColorBit1 = (1 << 2),
kFinderFlagColorBit0 = (1 << 1),
};
MacFinderInfo();
explicit MacFinderInfo(const MacFinderInfoData &data);
MacFinderInfoData toData() const;
byte type[4];
byte creator[4];
uint16 flags;
Common::Point position;
int16 windowID;
};
/**
* Class containing Macintosh Extended Finder Info.
*/
struct MacFinderExtendedInfo {
static const uint kDataSize = 16;
MacFinderExtendedInfo();
explicit MacFinderExtendedInfo(const MacFinderExtendedInfoData &data);
MacFinderExtendedInfoData toData() const;
int16 iconID;
int16 commentID;
int32 homeDirectoryID;
};
/**
* Class for handling Mac data and resource forks.
* It can read from raw, MacBinary, and AppleDouble formats.
*/
class MacResManager {
#define MBI_INFOHDR 128
public:
MacResManager();
~MacResManager();
/**
* Open a Mac data/resource fork pair.
*
* This uses SearchMan to find the data/resource forks. This should only be used
* from inside an engine.
*
* @param fileName The base file name of the file
* @note This will check for the raw resource fork, MacBinary, and AppleDouble formats.
* @return True on success
*/
bool open(const Path &fileName);
/**
* Open a Mac data/resource fork pair from within the given archive.
*
* @param path The path that holds the forks
* @param fileName The base file name of the file
* @note This will check for the raw resource fork, MacBinary, and AppleDouble formats.
* @return True on success
*/
bool open(const Path &fileName, Archive &archive);
/**
* Opens file named fileName or data fork extracted as macbin
* @return The stream if found, 0 otherwise
*/
static SeekableReadStream *openFileOrDataFork(const Path &fileName, Archive &archive);
static SeekableReadStream *openFileOrDataFork(const Path &fileName);
/**
* Open data fork of macbinary.
* @return The stream if found, 0 otherwise
*/
static SeekableReadStream *openDataForkFromMacBinary(SeekableReadStream *inStream, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::NO);
/**
* See if a Mac data/resource fork pair exists.
* @param fileName The base file name of the file
* @return True if either a data fork or resource fork with this name exists
*/
static bool exists(const Path &fileName);
/**
* Attempt to read the Mac Finder info metadata for a file path.
* @param fileName The base file name of the file
* @param archive The archive to search in
* @param outFinderInfo The loaded and parsed Finder info
* @param outFinderExtendedInfo The loaded and parsed Finder extended info
* @return True if finder info was available for a path, false if not
*/
static bool getFileFinderInfo(const Path &fileName, Archive &archive, MacFinderInfo &outFinderInfo);
static bool getFileFinderInfo(const Path &fileName, Archive &archive, MacFinderInfo &outFinderInfo, MacFinderExtendedInfo &outFinderExtendedInfo);
static bool getFileFinderInfo(const Path &fileName, MacFinderInfo &outFinderInfo);
static bool getFileFinderInfo(const Path &fileName, MacFinderInfo &outFinderInfo, MacFinderExtendedInfo &outFinderExtendedInfo);
/**
* List all filenames matching pattern for opening with open().
*
* @param files Array containing all matching filenames discovered. Only
* adds to the list.
* @param pattern Pattern to match against. Taking String::matchPattern's
* format.
*/
static void listFiles(Array<Path> &files, const Path &pattern);
/**
* Close the Mac data/resource fork pair.
*/
void close();
/**
* Query whether or not we have a resource fork present.
* @return True if the resource fork is present
*/
bool hasResFork() const;
/**
* Query whether or not we have a resource fork present.
* @return True if the resource fork is present
*/
bool hasDataFork() const;
/**
* Query whether the file is one of the Mac formats.
* @return True if the file is in MacBinary format or has a resource fork
*/
bool isMacFile() const { return _mode != kResForkNone; }
int getMode() const { return _mode; }
/**
* Read resource from the MacBinary file
* @param typeID FourCC of the type
* @param resID Resource ID to fetch
* @return Pointer to a SeekableReadStream with loaded resource
*/
SeekableReadStream *getResource(uint32 typeID, uint16 resID);
/**
* Read resource from the MacBinary file
* @note This will take the first resource that matches this name, regardless of type
* @param filename file name of the resource
* @return Pointer to a SeekableReadStream with loaded resource
*/
SeekableReadStream *getResource(const String &filename);
/**
* Read resource from the MacBinary file
* @param typeID FourCC of the type
* @param filename file name of the resource
* @return Pointer to a SeekableReadStream with loaded resource
*/
SeekableReadStream *getResource(uint32 typeID, const String &filename);
static int getDataForkOffset() { return MBI_INFOHDR; }
/**
* Get the name of a given resource
* @param typeID FourCC of the type
* @param resID Resource ID to fetch
* @return The name of a given resource and an empty string if not present
*/
String getResName(uint32 typeID, uint16 resID) const;
/**
* Get the length in bytes of a given resource
* @param typeID FourCC of the type
* @param resID Resource ID to fetch
* @return The length in bytes of a given resource
*/
uint32 getResLength(uint32 typeID, uint16 resID);
/**
* Get the size of the data portion of the resource fork
* @return The size of the data portion of the resource fork
*/
uint32 getResForkDataSize() const;
uint32 getResForkSize() const {
if (!hasResFork())
return 0;
return _resForkSize;
}
uint32 getDataForkSize() const {
if (!hasDataFork())
return 0;
return _dataLength;
}
/**
* Calculate the MD5 checksum of the resource fork
* @param length The maximum length to compute for
* @param tail Calculate length from the tail
* @return The MD5 checksum of the resource fork
*/
String computeResForkMD5AsString(uint32 length = 0, bool tail = false, ProgressUpdateCallback progressUpdateCallback = nullptr, void *callbackParameter = nullptr) const;
/**
* Get the base file name of the data/resource fork pair
* @return The base file name of the data/resource fork pair
*/
Path getBaseFileName() const { return _baseFileName; }
void setBaseFileName(Common::Path str) { _baseFileName = str; }
/**
* Return list of resource IDs with specified type ID
*/
MacResIDArray getResIDArray(uint32 typeID);
/**
* Return list of resource tags
*/
MacResTagArray getResTagArray();
/**
* Load from stream in MacBinary format
*/
bool loadFromMacBinary(SeekableReadStream *stream);
/**
* Dump contents of the archive to ./dumps directory
*/
void dumpRaw();
/**
* Check if the given stream is in the MacBinary format.
* @param stream The stream we're checking
*/
static bool isMacBinary(SeekableReadStream &stream);
struct MacVers {
byte majorVer;
byte minorVer;
byte devStage;
String devStr;
byte preReleaseVer;
uint16 region;
String str;
String msg;
};
static MacVers *parseVers(SeekableReadStream *vvers);
enum {
kResForkNone = 0,
kResForkRaw,
kResForkMacBinary,
kResForkAppleDouble
} _mode;
static Path constructAppleDoubleName(const Path &name);
private:
SeekableReadStream *_stream;
Path _baseFileName;
bool load(SeekableReadStream *stream);
bool loadFromRawFork(SeekableReadStream *stream);
bool loadFromAppleDouble(SeekableReadStream *stream);
/**
* Get Finder info from a file in MacBinary format
*/
static bool getFinderInfoFromMacBinary(SeekableReadStream *stream, MacFinderInfo &outFinderInfo, MacFinderExtendedInfo &outFinderExtendedInfo);
/**
* Get Finder info from a file in AppleDouble format
*/
static bool getFinderInfoFromAppleDouble(SeekableReadStream *stream, MacFinderInfo &outFinderInfo, MacFinderExtendedInfo &outFinderExtendedInfo);
static bool readAndValidateMacBinaryHeader(SeekableReadStream &stream, byte (&outMacBinaryHeader)[MBI_INFOHDR]);
static Path disassembleAppleDoubleName(const Path &name, bool *isAppleDouble);
static SeekableReadStream *openAppleDoubleWithAppleOrOSXNaming(Archive& archive, const Path &fileName);
/**
* Do a sanity check whether the given stream is a raw resource fork.
*
* @param stream Stream object to check. Will not preserve its position.
*/
static bool isRawFork(SeekableReadStream &stream);
void readMap();
struct ResMap {
uint16 resAttr;
uint16 typeOffset;
uint16 nameOffset;
uint16 numTypes;
void reset() {
resAttr = 0;
typeOffset = 0;
nameOffset = 0;
numTypes = 0;
}
ResMap() { reset(); }
};
struct ResType {
uint32 id;
uint16 items;
uint16 offset;
};
struct Resource {
uint16 id;
int16 nameOffset;
byte attr;
uint32 dataOffset;
char *name;
};
typedef Resource *ResPtr;
int32 _resForkOffset;
uint32 _resForkSize;
uint32 _dataOffset;
uint32 _dataLength;
uint32 _mapOffset;
uint32 _mapLength;
ResMap _resMap;
ResType *_resTypes;
ResPtr *_resLists;
};
/** @} */
} // End of namespace Common
#endif