archiver_wad.c
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
PHYSFS_uint32 startPos;
PHYSFS_uint32 size;
} WADentry;
typedef struct
{
char *filename;
PHYSFS_sint64 last_mod_time;
PHYSFS_uint32 entryCount;
PHYSFS_uint32 entryOffset;
WADentry *entries;
} WADinfo;
typedef struct
{
void *handle;
WADentry *entry;
PHYSFS_uint32 curPos;
} WADfileinfo;
79
static void WAD_dirClose(dvoid *opaque)
81
WADinfo *info = ((WADinfo *) opaque);
82
83
84
allocator.Free(info->filename);
allocator.Free(info->entries);
allocator.Free(info);
85
86
87
} /* WAD_dirClose */
88
static PHYSFS_sint64 WAD_read(fvoid *opaque, void *buffer,
89
90
PHYSFS_uint32 objSize, PHYSFS_uint32 objCount)
{
91
WADfileinfo *finfo = (WADfileinfo *) opaque;
92
93
94
95
96
97
98
99
100
101
102
103
WADentry *entry = finfo->entry;
PHYSFS_uint32 bytesLeft = entry->size - finfo->curPos;
PHYSFS_uint32 objsLeft = (bytesLeft / objSize);
PHYSFS_sint64 rc;
if (objsLeft < objCount)
objCount = objsLeft;
rc = __PHYSFS_platformRead(finfo->handle, buffer, objSize, objCount);
if (rc > 0)
finfo->curPos += (PHYSFS_uint32) (rc * objSize);
105
106
107
} /* WAD_read */
108
static PHYSFS_sint64 WAD_write(fvoid *opaque, const void *buffer,
109
110
111
112
113
114
PHYSFS_uint32 objSize, PHYSFS_uint32 objCount)
{
BAIL_MACRO(ERR_NOT_SUPPORTED, -1);
} /* WAD_write */
115
static int WAD_eof(fvoid *opaque)
117
WADfileinfo *finfo = (WADfileinfo *) opaque;
118
WADentry *entry = finfo->entry;
119
return (finfo->curPos >= entry->size);
120
121
122
} /* WAD_eof */
123
static PHYSFS_sint64 WAD_tell(fvoid *opaque)
125
return ((WADfileinfo *) opaque)->curPos;
126
127
128
} /* WAD_tell */
129
static int WAD_seek(fvoid *opaque, PHYSFS_uint64 offset)
131
WADfileinfo *finfo = (WADfileinfo *) opaque;
132
133
134
135
136
137
138
139
140
WADentry *entry = finfo->entry;
int rc;
BAIL_IF_MACRO(offset < 0, ERR_INVALID_ARGUMENT, 0);
BAIL_IF_MACRO(offset >= entry->size, ERR_PAST_EOF, 0);
rc = __PHYSFS_platformSeek(finfo->handle, entry->startPos + offset);
if (rc)
finfo->curPos = (PHYSFS_uint32) offset;
142
143
144
} /* WAD_seek */
145
static PHYSFS_sint64 WAD_fileLength(fvoid *opaque)
147
WADfileinfo *finfo = (WADfileinfo *) opaque;
148
return ((PHYSFS_sint64) finfo->entry->size);
149
150
151
} /* WAD_fileLength */
152
static int WAD_fileClose(fvoid *opaque)
154
WADfileinfo *finfo = (WADfileinfo *) opaque;
155
BAIL_IF_MACRO(!__PHYSFS_platformClose(finfo->handle), NULL, 0);
156
allocator.Free(finfo);
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
} /* WAD_fileClose */
static int wad_open(const char *filename, int forWriting,
void **fh, PHYSFS_uint32 *count,PHYSFS_uint32 *offset)
{
PHYSFS_uint8 buf[4];
*fh = NULL;
BAIL_IF_MACRO(forWriting, ERR_ARC_IS_READ_ONLY, 0);
*fh = __PHYSFS_platformOpenRead(filename);
BAIL_IF_MACRO(*fh == NULL, NULL, 0);
if (__PHYSFS_platformRead(*fh, buf, 4, 1) != 1)
goto openWad_failed;
if (memcmp(buf, "IWAD", 4) != 0 && memcmp(buf, "PWAD", 4) != 0)
{
__PHYSFS_setError(ERR_UNSUPPORTED_ARCHIVE);
goto openWad_failed;
} /* if */
if (__PHYSFS_platformRead(*fh, count, sizeof (PHYSFS_uint32), 1) != 1)
goto openWad_failed;
*count = PHYSFS_swapULE32(*count);
if (__PHYSFS_platformRead(*fh, offset, sizeof (PHYSFS_uint32), 1) != 1)
goto openWad_failed;
*offset = PHYSFS_swapULE32(*offset);
192
193
194
195
196
197
198
openWad_failed:
if (*fh != NULL)
__PHYSFS_platformClose(*fh);
*count = -1;
*fh = NULL;
200
201
202
203
204
205
206
207
208
209
210
211
} /* wad_open */
static int WAD_isArchive(const char *filename, int forWriting)
{
void *fh;
PHYSFS_uint32 fileCount,offset;
int retval = wad_open(filename, forWriting, &fh, &fileCount,&offset);
if (fh != NULL)
__PHYSFS_platformClose(fh);
212
return retval;
213
214
215
216
217
} /* WAD_isArchive */
static int wad_entry_cmp(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
218
219
220
if (one != two)
{
const WADentry *a = (const WADentry *) _a;
221
return strcmp(a[one].name, a[two].name);
222
223
224
} /* if */
return 0;
225
226
227
228
229
} /* wad_entry_cmp */
static void wad_entry_swap(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
230
231
232
233
234
235
236
237
238
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 */
239
240
241
242
243
244
245
246
247
} /* wad_entry_swap */
static int wad_load_entries(const char *name, int forWriting, WADinfo *info)
{
void *fh = NULL;
PHYSFS_uint32 fileCount;
PHYSFS_uint32 directoryOffset;
WADentry *entry;
248
char lastDirectory[9];
249
250
lastDirectory[8] = 0; /* Make sure lastDirectory stays null-terminated. */
251
252
253
BAIL_IF_MACRO(!wad_open(name, forWriting, &fh, &fileCount,&directoryOffset), NULL, 0);
info->entryCount = fileCount;
254
info->entries = (WADentry *) allocator.Malloc(sizeof(WADentry)*fileCount);
255
256
257
258
259
260
261
262
263
264
265
266
267
if (info->entries == NULL)
{
__PHYSFS_platformClose(fh);
BAIL_MACRO(ERR_OUT_OF_MEMORY, 0);
} /* if */
__PHYSFS_platformSeek(fh,directoryOffset);
for (entry = info->entries; fileCount > 0; fileCount--, entry++)
{
if (__PHYSFS_platformRead(fh, &entry->startPos, 4, 1) != 1)
{
__PHYSFS_platformClose(fh);
269
270
271
272
273
} /* if */
if (__PHYSFS_platformRead(fh, &entry->size, 4, 1) != 1)
{
__PHYSFS_platformClose(fh);
275
276
277
278
279
} /* if */
if (__PHYSFS_platformRead(fh, &entry->name, 8, 1) != 1)
{
__PHYSFS_platformClose(fh);
281
282
283
284
285
286
287
288
289
290
291
} /* if */
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 */
__PHYSFS_platformClose(fh);
__PHYSFS_sort(info->entries, info->entryCount,
wad_entry_cmp, wad_entry_swap);
293
294
295
} /* wad_load_entries */
296
static void *WAD_openArchive(const char *name, int forWriting)
297
298
{
PHYSFS_sint64 modtime = __PHYSFS_platformGetLastModTime(name);
299
WADinfo *info = (WADinfo *) allocator.Malloc(sizeof (WADinfo));
301
BAIL_IF_MACRO(info == NULL, ERR_OUT_OF_MEMORY, NULL);
302
303
memset(info, '\0', sizeof (WADinfo));
304
info->filename = (char *) allocator.Malloc(strlen(name) + 1);
305
GOTO_IF_MACRO(!info->filename, ERR_OUT_OF_MEMORY, WAD_openArchive_failed);
306
307
308
309
310
311
if (!wad_load_entries(name, forWriting, info))
goto WAD_openArchive_failed;
strcpy(info->filename, name);
info->last_mod_time = modtime;
313
314
WAD_openArchive_failed:
315
if (info != NULL)
317
if (info->filename != NULL)
318
allocator.Free(info->filename);
319
if (info->entries != NULL)
320
321
allocator.Free(info->entries);
allocator.Free(info);
322
323
} /* if */
325
326
327
} /* WAD_openArchive */
328
static void WAD_enumerateFiles(dvoid *opaque, const char *dname,
329
330
int omitSymLinks, PHYSFS_EnumFilesCallback cb,
const char *origdir, void *callbackdata)
332
WADinfo *info = ((WADinfo *) opaque);
333
334
335
WADentry *entry = info->entries;
PHYSFS_uint32 max = info->entryCount;
PHYSFS_uint32 i;
336
const char *name;
337
char *sep;
339
if (*dname == '\0') /* root directory enumeration? */
340
341
342
{
for (i = 0; i < max; i++, entry++)
{
343
344
name = entry->name;
if (strchr(name, '/') == NULL)
345
cb(callbackdata, origdir, name);
346
347
348
349
350
351
} /* for */
} /* if */
else
{
for (i = 0; i < max; i++, entry++)
{
352
353
name = entry->name;
sep = strchr(name, '/');
354
355
if (sep != NULL)
{
356
if (strncmp(dname, name, (sep - name)) == 0)
357
cb(callbackdata, origdir, sep + 1);
358
359
360
} /* if */
} /* for */
} /* else */
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
} /* WAD_enumerateFiles */
static WADentry *wad_find_entry(WADinfo *info, const char *name)
{
WADentry *a = info->entries;
PHYSFS_sint32 lo = 0;
PHYSFS_sint32 hi = (PHYSFS_sint32) (info->entryCount - 1);
PHYSFS_sint32 middle;
int rc;
while (lo <= hi)
{
middle = lo + ((hi - lo) / 2);
rc = strcmp(name, a[middle].name);
if (rc == 0) /* found it! */
377
return &a[middle];
378
379
380
381
382
383
384
385
386
387
else if (rc > 0)
lo = middle + 1;
else
hi = middle - 1;
} /* while */
BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);
} /* wad_find_entry */
388
static int WAD_exists(dvoid *opaque, const char *name)
390
return (wad_find_entry((WADinfo *) opaque, name) != NULL);
391
392
393
} /* WAD_exists */
394
static int WAD_isDirectory(dvoid *opaque, const char *name, int *fileExists)
396
WADentry *entry = wad_find_entry(((WADinfo *) opaque), name);
397
398
399
400
401
402
403
404
if (entry != NULL)
{
char *n;
*fileExists = 1;
/* Can't be a directory if it's a subdirectory. */
if (strchr(entry->name, '/') != NULL)
406
407
408
409
410
411
/* Check if it matches "MAP??" or "E?M?" ... */
n = entry->name;
if ((n[0] == 'E' && n[2] == 'M') ||
(n[0] == 'M' && n[1] == 'A' && n[2] == 'P' && n[6] == 0))
{
413
} /* if */
415
416
417
418
} /* if */
else
{
*fileExists = 0;
420
} /* else */
421
422
423
} /* WAD_isDirectory */
424
static int WAD_isSymLink(dvoid *opaque, const char *name, int *fileExists)
426
*fileExists = WAD_exists(opaque, name);
427
return 0; /* never symlinks in a wad. */
428
429
430
} /* WAD_isSymLink */
431
static PHYSFS_sint64 WAD_getLastModTime(dvoid *opaque,
432
433
434
const char *name,
int *fileExists)
{
435
WADinfo *info = ((WADinfo *) opaque);
436
437
438
439
PHYSFS_sint64 retval = -1;
*fileExists = (wad_find_entry(info, name) != NULL);
if (*fileExists) /* use time of WAD itself in the physical filesystem. */
440
retval = info->last_mod_time;
442
return retval;
443
444
445
} /* WAD_getLastModTime */
446
447
448
449
450
451
static int WAD_stat(dvoid *opaque, const char *name, PHYSFS_Stat *st)
{
return -1; /* !!! FIXME: write me */
} /* WAD_stat */
452
static fvoid *WAD_openRead(dvoid *opaque, const char *fnm, int *fileExists)
454
WADinfo *info = ((WADinfo *) opaque);
455
456
457
458
459
460
461
WADfileinfo *finfo;
WADentry *entry;
entry = wad_find_entry(info, fnm);
*fileExists = (entry != NULL);
BAIL_IF_MACRO(entry == NULL, NULL, NULL);
462
finfo = (WADfileinfo *) allocator.Malloc(sizeof (WADfileinfo));
463
BAIL_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, NULL);
464
465
466
467
468
finfo->handle = __PHYSFS_platformOpenRead(info->filename);
if ( (finfo->handle == NULL) ||
(!__PHYSFS_platformSeek(finfo->handle, entry->startPos)) )
{
469
allocator.Free(finfo);
471
472
473
474
} /* if */
finfo->curPos = 0;
finfo->entry = entry;
476
477
478
} /* WAD_openRead */
479
static fvoid *WAD_openWrite(dvoid *opaque, const char *name)
480
481
482
483
484
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* WAD_openWrite */
485
static fvoid *WAD_openAppend(dvoid *opaque, const char *name)
486
487
488
489
490
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* WAD_openAppend */
491
static int WAD_remove(dvoid *opaque, const char *name)
492
493
494
495
496
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* WAD_remove */
497
static int WAD_mkdir(dvoid *opaque, const char *name)
498
499
500
501
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* WAD_mkdir */
502
503
504
505
const PHYSFS_ArchiveInfo __PHYSFS_ArchiveInfo_WAD =
{
"WAD",
506
WAD_ARCHIVE_DESCRIPTION,
507
508
509
510
511
512
513
514
515
516
517
518
"Travis Wells <traviswells@mchsi.com>",
"http://www.3dmm2.com/doom/",
};
const PHYSFS_Archiver __PHYSFS_Archiver_WAD =
{
&__PHYSFS_ArchiveInfo_WAD,
WAD_isArchive, /* isArchive() method */
WAD_openArchive, /* openArchive() method */
WAD_enumerateFiles, /* enumerateFiles() method */
WAD_exists, /* exists() method */
519
WAD_stat, /* stat() method */
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
WAD_isDirectory, /* isDirectory() method */
WAD_isSymLink, /* isSymLink() method */
WAD_getLastModTime, /* getLastModTime() 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 */
WAD_read, /* read() method */
WAD_write, /* write() method */
WAD_eof, /* eof() method */
WAD_tell, /* tell() method */
WAD_seek, /* seek() method */
WAD_fileLength, /* fileLength() method */
WAD_fileClose /* fileClose() method */
};
538
539
540
#endif /* defined PHYSFS_SUPPORTS_WAD */
/* end of wad.c ... */