/
archiver_wad.c
455 lines (358 loc) · 12.4 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
/*
* WAD support routines for PhysicsFS.
*
* This driver handles DOOM engine archives ("wads").
* This format (but not this driver) was designed by id Software for use
* with the DOOM engine.
* The specs of the format are from the unofficial doom specs v1.666
* found here: http://www.gamers.org/dhs/helpdocs/dmsp1666.html
* The format of the archive: (from the specs)
*
* A WAD file has three parts:
* (1) a twelve-byte header
* (2) one or more "lumps"
* (3) a directory or "info table" that contains the names, offsets, and
* sizes of all the lumps in the WAD
*
* The header consists of three four-byte parts:
* (a) an ASCII string which must be either "IWAD" or "PWAD"
* (b) a 4-byte (long) integer which is the number of lumps in the wad
* (c) a long integer which is the file offset to the start of
* the directory
*
* The directory has one 16-byte entry for every lump. Each entry consists
* of three parts:
*
* (a) a long integer, the file offset to the start of the lump
* (b) a long integer, the size of the lump in bytes
* (c) an 8-byte ASCII string, the name of the lump, padded with zeros.
* For example, the "DEMO1" entry in hexadecimal would be
* (44 45 4D 4F 31 00 00 00)
*
* Note that there is no way to tell if an opened WAD archive is a
* IWAD or PWAD with this archiver.
* I couldn't think of a way to provide that information, without being too
* hacky.
* I don't think it's really that important though.
*
*
39
* Please see the file LICENSE.txt in the source's root directory.
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
*
* This file written by Travis Wells, based on the GRP archiver by
* Ryan C. Gordon.
*/
#if (defined PHYSFS_SUPPORTS_WAD)
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "physfs.h"
#define __PHYSICSFS_INTERNAL__
#include "physfs_internal.h"
typedef struct
{
57
char name[18];
58
59
60
61
62
63
PHYSFS_uint32 startPos;
PHYSFS_uint32 size;
} WADentry;
typedef struct
{
64
PHYSFS_Io *io;
65
66
67
68
69
70
PHYSFS_uint32 entryCount;
WADentry *entries;
} WADinfo;
typedef struct
{
71
PHYSFS_Io *io;
72
73
74
75
76
WADentry *entry;
PHYSFS_uint32 curPos;
} WADfileinfo;
77
78
79
80
81
82
static inline int readAll(PHYSFS_Io *io, void *buf, const PHYSFS_uint64 len)
{
return (io->read(io, buf, len) == len);
} /* readAll */
83
static void WAD_dirClose(dvoid *opaque)
84
{
85
WADinfo *info = ((WADinfo *) opaque);
86
info->io->destroy(info->io);
87
88
allocator.Free(info->entries);
allocator.Free(info);
89
90
91
} /* WAD_dirClose */
92
static PHYSFS_sint64 WAD_read(PHYSFS_Io *io, void *buffer, PHYSFS_uint64 len)
93
{
94
WADfileinfo *finfo = (WADfileinfo *) io->opaque;
95
96
const WADentry *entry = finfo->entry;
const PHYSFS_uint64 bytesLeft = (PHYSFS_uint64)(entry->size-finfo->curPos);
97
98
PHYSFS_sint64 rc;
99
100
if (bytesLeft < len)
len = bytesLeft;
101
102
rc = finfo->io->read(finfo->io, buffer, len);
103
if (rc > 0)
104
finfo->curPos += (PHYSFS_uint32) rc;
105
106
return rc;
107
108
109
} /* WAD_read */
110
static PHYSFS_sint64 WAD_write(PHYSFS_Io *io, const void *b, PHYSFS_uint64 len)
111
112
113
114
115
{
BAIL_MACRO(ERR_NOT_SUPPORTED, -1);
} /* WAD_write */
116
static PHYSFS_sint64 WAD_tell(PHYSFS_Io *io)
117
{
118
return ((WADfileinfo *) io->opaque)->curPos;
119
120
121
} /* WAD_tell */
122
static int WAD_seek(PHYSFS_Io *io, PHYSFS_uint64 offset)
123
{
124
125
WADfileinfo *finfo = (WADfileinfo *) io->opaque;
const WADentry *entry = finfo->entry;
126
127
128
int rc;
BAIL_IF_MACRO(offset >= entry->size, ERR_PAST_EOF, 0);
129
rc = finfo->io->seek(finfo->io, entry->startPos + offset);
130
131
132
if (rc)
finfo->curPos = (PHYSFS_uint32) offset;
133
return rc;
134
135
136
} /* WAD_seek */
137
static PHYSFS_sint64 WAD_length(PHYSFS_Io *io)
138
{
139
const WADfileinfo *finfo = (WADfileinfo *) io->opaque;
140
return ((PHYSFS_sint64) finfo->entry->size);
141
} /* WAD_length */
142
143
144
static PHYSFS_Io *WAD_duplicate(PHYSFS_Io *_io)
145
{
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
WADfileinfo *origfinfo = (WADfileinfo *) _io->opaque;
PHYSFS_Io *io = NULL;
PHYSFS_Io *retval = (PHYSFS_Io *) allocator.Malloc(sizeof (PHYSFS_Io));
WADfileinfo *finfo = (WADfileinfo *) allocator.Malloc(sizeof (WADfileinfo));
GOTO_IF_MACRO(retval == NULL, ERR_OUT_OF_MEMORY, WAD_duplicate_failed);
GOTO_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, WAD_duplicate_failed);
io = origfinfo->io->duplicate(origfinfo->io);
GOTO_IF_MACRO(io == NULL, NULL, WAD_duplicate_failed);
finfo->io = io;
finfo->entry = origfinfo->entry;
finfo->curPos = 0;
memcpy(retval, _io, sizeof (PHYSFS_Io));
retval->opaque = finfo;
return retval;
WAD_duplicate_failed:
if (finfo != NULL) allocator.Free(finfo);
if (retval != NULL) allocator.Free(retval);
if (io != NULL) io->destroy(io);
return NULL;
} /* WAD_duplicate */
168
169
static int WAD_flush(PHYSFS_Io *io) { return 1; /* no write support. */ }
170
171
static void WAD_destroy(PHYSFS_Io *io)
172
{
173
174
175
176
177
WADfileinfo *finfo = (WADfileinfo *) io->opaque;
finfo->io->destroy(finfo->io);
allocator.Free(finfo);
allocator.Free(io);
} /* WAD_destroy */
178
179
180
static const PHYSFS_Io WAD_Io =
181
{
182
183
184
185
186
187
188
189
190
191
WAD_read,
WAD_write,
WAD_seek,
WAD_tell,
WAD_length,
WAD_duplicate,
WAD_flush,
WAD_destroy,
NULL
};
192
193
194
195
static int wadEntryCmp(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
196
{
197
198
199
if (one != two)
{
const WADentry *a = (const WADentry *) _a;
200
return __PHYSFS_stricmpASCII(a[one].name, a[two].name);
201
202
203
} /* if */
return 0;
204
} /* wadEntryCmp */
205
206
207
static void wadEntrySwap(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
208
{
209
210
211
212
213
214
215
216
217
if (one != two)
{
WADentry tmp;
WADentry *first = &(((WADentry *) _a)[one]);
WADentry *second = &(((WADentry *) _a)[two]);
memcpy(&tmp, first, sizeof (WADentry));
memcpy(first, second, sizeof (WADentry));
memcpy(second, &tmp, sizeof (WADentry));
} /* if */
218
} /* wadEntrySwap */
219
220
221
static int wad_load_entries(PHYSFS_Io *io, WADinfo *info)
222
{
223
PHYSFS_uint32 fileCount = info->entryCount;
224
225
PHYSFS_uint32 directoryOffset;
WADentry *entry;
226
227
228
BAIL_IF_MACRO(!readAll(io, &directoryOffset, 4), NULL, 0);
directoryOffset = PHYSFS_swapULE32(directoryOffset);
229
230
info->entries = (WADentry *) allocator.Malloc(sizeof(WADentry)*fileCount);
231
232
BAIL_IF_MACRO(info->entries == NULL, ERR_OUT_OF_MEMORY, 0);
BAIL_IF_MACRO(!io->seek(io, directoryOffset), NULL, 0);
233
234
235
for (entry = info->entries; fileCount > 0; fileCount--, entry++)
{
236
237
238
BAIL_IF_MACRO(!readAll(io, &entry->startPos, 4), NULL, 0);
BAIL_IF_MACRO(!readAll(io, &entry->size, 4), NULL, 0);
BAIL_IF_MACRO(!readAll(io, &entry->name, 8), NULL, 0);
239
240
241
242
243
244
entry->name[8] = '\0'; /* name might not be null-terminated in file. */
entry->size = PHYSFS_swapULE32(entry->size);
entry->startPos = PHYSFS_swapULE32(entry->startPos);
} /* for */
245
__PHYSFS_sort(info->entries, info->entryCount, wadEntryCmp, wadEntrySwap);
246
return 1;
247
248
249
} /* wad_load_entries */
250
static void *WAD_openArchive(PHYSFS_Io *io, const char *name, int forWriting)
251
{
252
253
254
PHYSFS_uint8 buf[4];
WADinfo *info = NULL;
PHYSFS_uint32 val = 0;
255
256
257
258
259
260
261
262
263
264
265
assert(io != NULL); /* shouldn't ever happen. */
BAIL_IF_MACRO(forWriting, ERR_ARC_IS_READ_ONLY, 0);
BAIL_IF_MACRO(!readAll(io, buf, sizeof (buf)), NULL, NULL);
if ((memcmp(buf, "IWAD", 4) != 0) && (memcmp(buf, "PWAD", 4) != 0))
GOTO_MACRO(ERR_NOT_AN_ARCHIVE, WAD_openArchive_failed);
info = (WADinfo *) allocator.Malloc(sizeof (WADinfo));
GOTO_IF_MACRO(info == NULL, ERR_OUT_OF_MEMORY, WAD_openArchive_failed);
266
memset(info, '\0', sizeof (WADinfo));
267
info->io = io;
268
269
270
GOTO_IF_MACRO(!readAll(io,&val,sizeof(val)), NULL, WAD_openArchive_failed);
info->entryCount = PHYSFS_swapULE32(val);
271
272
GOTO_IF_MACRO(!wad_load_entries(io, info), NULL, WAD_openArchive_failed);
273
274
return info;
275
276
WAD_openArchive_failed:
277
if (info != NULL)
278
{
279
if (info->entries != NULL)
280
281
allocator.Free(info->entries);
allocator.Free(info);
282
283
} /* if */
284
return NULL;
285
286
287
} /* WAD_openArchive */
288
static void WAD_enumerateFiles(dvoid *opaque, const char *dname,
289
290
int omitSymLinks, PHYSFS_EnumFilesCallback cb,
const char *origdir, void *callbackdata)
291
{
292
293
/* no directories in WAD files. */
if (*dname == '\0')
294
{
295
296
297
298
299
WADinfo *info = (WADinfo *) opaque;
WADentry *entry = info->entries;
PHYSFS_uint32 max = info->entryCount;
PHYSFS_uint32 i;
300
for (i = 0; i < max; i++, entry++)
301
cb(callbackdata, origdir, entry->name);
302
} /* if */
303
304
305
} /* WAD_enumerateFiles */
306
static WADentry *wad_find_entry(const WADinfo *info, const char *name)
307
{
308
char *ptr = strchr(name, '.');
309
310
311
312
313
314
WADentry *a = info->entries;
PHYSFS_sint32 lo = 0;
PHYSFS_sint32 hi = (PHYSFS_sint32) (info->entryCount - 1);
PHYSFS_sint32 middle;
int rc;
315
316
317
318
319
320
321
322
/*
* Rule out filenames to avoid unneeded processing...no dirs,
* big filenames, or extensions.
*/
BAIL_IF_MACRO(ptr != NULL, ERR_NO_SUCH_FILE, NULL);
BAIL_IF_MACRO(strlen(name) > 8, ERR_NO_SUCH_FILE, NULL);
BAIL_IF_MACRO(strchr(name, '/') != NULL, ERR_NO_SUCH_FILE, NULL);
323
324
325
while (lo <= hi)
{
middle = lo + ((hi - lo) / 2);
326
rc = __PHYSFS_stricmpASCII(name, a[middle].name);
327
if (rc == 0) /* found it! */
328
return &a[middle];
329
330
331
332
333
334
335
336
337
338
else if (rc > 0)
lo = middle + 1;
else
hi = middle - 1;
} /* while */
BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);
} /* wad_find_entry */
339
static PHYSFS_Io *WAD_openRead(dvoid *opaque, const char *fnm, int *fileExists)
340
{
341
342
PHYSFS_Io *retval = NULL;
WADinfo *info = (WADinfo *) opaque;
343
344
345
346
347
WADfileinfo *finfo;
WADentry *entry;
entry = wad_find_entry(info, fnm);
*fileExists = (entry != NULL);
348
349
350
351
GOTO_IF_MACRO(entry == NULL, NULL, WAD_openRead_failed);
retval = (PHYSFS_Io *) allocator.Malloc(sizeof (PHYSFS_Io));
GOTO_IF_MACRO(retval == NULL, ERR_OUT_OF_MEMORY, WAD_openRead_failed);
352
353
finfo = (WADfileinfo *) allocator.Malloc(sizeof (WADfileinfo));
354
GOTO_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, WAD_openRead_failed);
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
finfo->io = info->io->duplicate(info->io);
GOTO_IF_MACRO(finfo->io == NULL, NULL, WAD_openRead_failed);
if (!finfo->io->seek(finfo->io, entry->startPos))
GOTO_MACRO(NULL, WAD_openRead_failed);
finfo->curPos = 0;
finfo->entry = entry;
memcpy(retval, &WAD_Io, sizeof (*retval));
retval->opaque = finfo;
return retval;
WAD_openRead_failed:
if (finfo != NULL)
371
{
372
373
if (finfo->io != NULL)
finfo->io->destroy(finfo->io);
374
allocator.Free(finfo);
375
376
} /* if */
377
378
379
380
if (retval != NULL)
allocator.Free(retval);
return NULL;
381
382
383
} /* WAD_openRead */
384
static PHYSFS_Io *WAD_openWrite(dvoid *opaque, const char *name)
385
386
387
388
389
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* WAD_openWrite */
390
static PHYSFS_Io *WAD_openAppend(dvoid *opaque, const char *name)
391
392
393
394
395
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* WAD_openAppend */
396
static int WAD_remove(dvoid *opaque, const char *name)
397
398
399
400
401
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* WAD_remove */
402
static int WAD_mkdir(dvoid *opaque, const char *name)
403
404
405
406
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* WAD_mkdir */
407
408
static int WAD_stat(dvoid *opaque, const char *filename, int *exists,
409
410
411
412
413
414
415
416
417
418
419
PHYSFS_Stat *stat)
{
const WADinfo *info = (const WADinfo *) opaque;
const WADentry *entry = wad_find_entry(info, filename);
*exists = (entry != 0);
if (!entry)
return 0;
stat->filesize = entry->size;
stat->filetype = PHYSFS_FILETYPE_REGULAR;
420
421
stat->modtime = -1;
stat->createtime = -1;
422
423
stat->accesstime = -1;
stat->readonly = 1;
424
425
return 1;
426
427
428
} /* WAD_stat */
429
430
431
const PHYSFS_ArchiveInfo __PHYSFS_ArchiveInfo_WAD =
{
"WAD",
432
WAD_ARCHIVE_DESCRIPTION,
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
"Travis Wells <traviswells@mchsi.com>",
"http://www.3dmm2.com/doom/",
};
const PHYSFS_Archiver __PHYSFS_Archiver_WAD =
{
&__PHYSFS_ArchiveInfo_WAD,
WAD_openArchive, /* openArchive() method */
WAD_enumerateFiles, /* enumerateFiles() method */
WAD_openRead, /* openRead() method */
WAD_openWrite, /* openWrite() method */
WAD_openAppend, /* openAppend() method */
WAD_remove, /* remove() method */
WAD_mkdir, /* mkdir() method */
WAD_dirClose, /* dirClose() method */
449
WAD_stat /* stat() method */
450
451
};
452
453
454
#endif /* defined PHYSFS_SUPPORTS_WAD */
/* end of wad.c ... */