/
wad.c
526 lines (418 loc) · 14.3 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
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)
80
{
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
104
105
106
107
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);
return(rc);
} /* 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)
116
{
117
WADfileinfo *finfo = (WADfileinfo *) opaque;
118
119
120
121
122
WADentry *entry = finfo->entry;
return(finfo->curPos >= entry->size);
} /* WAD_eof */
123
static PHYSFS_sint64 WAD_tell(fvoid *opaque)
124
{
125
return(((WADfileinfo *) opaque)->curPos);
126
127
128
} /* WAD_tell */
129
static int WAD_seek(fvoid *opaque, PHYSFS_uint64 offset)
130
{
131
WADfileinfo *finfo = (WADfileinfo *) opaque;
132
133
134
135
136
137
138
139
140
141
142
143
144
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;
return(rc);
} /* WAD_seek */
145
static PHYSFS_sint64 WAD_fileLength(fvoid *opaque)
146
{
147
WADfileinfo *finfo = (WADfileinfo *) opaque;
148
149
150
151
return((PHYSFS_sint64) finfo->entry->size);
} /* WAD_fileLength */
152
static int WAD_fileClose(fvoid *opaque)
153
{
154
WADfileinfo *finfo = (WADfileinfo *) opaque;
155
BAIL_IF_MACRO(!__PHYSFS_platformClose(finfo->handle), NULL, 0);
156
allocator.Free(finfo);
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
return(1);
} /* 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);
return(1);
openWad_failed:
if (*fh != NULL)
__PHYSFS_platformClose(*fh);
*count = -1;
*fh = NULL;
return(0);
} /* 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);
return(retval);
} /* WAD_isArchive */
static int wad_entry_cmp(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
WADentry *a = (WADentry *) _a;
return(strcmp(a[one].name, a[two].name));
} /* wad_entry_cmp */
static void wad_entry_swap(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 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));
} /* 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;
240
char lastDirectory[9];
241
242
lastDirectory[8] = 0; /* Make sure lastDirectory stays null-terminated. */
243
244
245
BAIL_IF_MACRO(!wad_open(name, forWriting, &fh, &fileCount,&directoryOffset), NULL, 0);
info->entryCount = fileCount;
246
info->entries = (WADentry *) allocator.Malloc(sizeof(WADentry)*fileCount);
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
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);
return(0);
} /* if */
if (__PHYSFS_platformRead(fh, &entry->size, 4, 1) != 1)
{
__PHYSFS_platformClose(fh);
return(0);
} /* if */
if (__PHYSFS_platformRead(fh, &entry->name, 8, 1) != 1)
{
__PHYSFS_platformClose(fh);
return(0);
} /* 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);
return(1);
} /* wad_load_entries */
288
static void *WAD_openArchive(const char *name, int forWriting)
289
290
{
PHYSFS_sint64 modtime = __PHYSFS_platformGetLastModTime(name);
291
WADinfo *info = (WADinfo *) allocator.Malloc(sizeof (WADinfo));
292
293
BAIL_IF_MACRO(info == NULL, ERR_OUT_OF_MEMORY, NULL);
294
295
memset(info, '\0', sizeof (WADinfo));
296
info->filename = (char *) allocator.Malloc(strlen(name) + 1);
297
GOTO_IF_MACRO(!info->filename, ERR_OUT_OF_MEMORY, WAD_openArchive_failed);
298
299
300
301
302
303
if (!wad_load_entries(name, forWriting, info))
goto WAD_openArchive_failed;
strcpy(info->filename, name);
info->last_mod_time = modtime;
304
return(info);
305
306
WAD_openArchive_failed:
307
if (info != NULL)
308
{
309
if (info->filename != NULL)
310
allocator.Free(info->filename);
311
if (info->entries != NULL)
312
313
allocator.Free(info->entries);
allocator.Free(info);
314
315
316
317
318
319
} /* if */
return(NULL);
} /* WAD_openArchive */
320
static void WAD_enumerateFiles(dvoid *opaque, const char *dname,
321
322
int omitSymLinks, PHYSFS_EnumFilesCallback cb,
const char *origdir, void *callbackdata)
323
{
324
WADinfo *info = ((WADinfo *) opaque);
325
326
327
WADentry *entry = info->entries;
PHYSFS_uint32 max = info->entryCount;
PHYSFS_uint32 i;
328
const char *name;
329
char *sep;
330
331
if (*dname == '\0') /* root directory enumeration? */
332
333
334
{
for (i = 0; i < max; i++, entry++)
{
335
336
name = entry->name;
if (strchr(name, '/') == NULL)
337
cb(callbackdata, origdir, name);
338
339
340
341
342
343
} /* for */
} /* if */
else
{
for (i = 0; i < max; i++, entry++)
{
344
345
name = entry->name;
sep = strchr(name, '/');
346
347
if (sep != NULL)
{
348
if (strncmp(dname, name, (sep - name)) == 0)
349
cb(callbackdata, origdir, sep + 1);
350
351
352
} /* if */
} /* for */
} /* else */
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
} /* 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! */
return(&a[middle]);
else if (rc > 0)
lo = middle + 1;
else
hi = middle - 1;
} /* while */
BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);
} /* wad_find_entry */
380
static int WAD_exists(dvoid *opaque, const char *name)
381
{
382
return(wad_find_entry(((WADinfo *) opaque), name) != NULL);
383
384
385
} /* WAD_exists */
386
static int WAD_isDirectory(dvoid *opaque, const char *name, int *fileExists)
387
{
388
WADentry *entry = wad_find_entry(((WADinfo *) opaque), name);
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
if (entry != NULL)
{
char *n;
*fileExists = 1;
/* Can't be a directory if it's a subdirectory. */
if (strchr(entry->name, '/') != NULL)
return(0);
/* 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))
{
return(1);
} /* if */
return(0);
} /* if */
else
{
*fileExists = 0;
return(0);
} /* else */
413
414
415
} /* WAD_isDirectory */
416
static int WAD_isSymLink(dvoid *opaque, const char *name, int *fileExists)
417
{
418
*fileExists = WAD_exists(opaque, name);
419
420
421
422
return(0); /* never symlinks in a wad. */
} /* WAD_isSymLink */
423
static PHYSFS_sint64 WAD_getLastModTime(dvoid *opaque,
424
425
426
const char *name,
int *fileExists)
{
427
WADinfo *info = ((WADinfo *) opaque);
428
429
430
431
PHYSFS_sint64 retval = -1;
*fileExists = (wad_find_entry(info, name) != NULL);
if (*fileExists) /* use time of WAD itself in the physical filesystem. */
432
retval = info->last_mod_time;
433
434
435
436
437
return(retval);
} /* WAD_getLastModTime */
438
static fvoid *WAD_openRead(dvoid *opaque, const char *fnm, int *fileExists)
439
{
440
WADinfo *info = ((WADinfo *) opaque);
441
442
443
444
445
446
447
WADfileinfo *finfo;
WADentry *entry;
entry = wad_find_entry(info, fnm);
*fileExists = (entry != NULL);
BAIL_IF_MACRO(entry == NULL, NULL, NULL);
448
finfo = (WADfileinfo *) allocator.Malloc(sizeof (WADfileinfo));
449
BAIL_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, NULL);
450
451
452
453
454
finfo->handle = __PHYSFS_platformOpenRead(info->filename);
if ( (finfo->handle == NULL) ||
(!__PHYSFS_platformSeek(finfo->handle, entry->startPos)) )
{
455
allocator.Free(finfo);
456
457
458
459
460
return(NULL);
} /* if */
finfo->curPos = 0;
finfo->entry = entry;
461
return(finfo);
462
463
464
} /* WAD_openRead */
465
static fvoid *WAD_openWrite(dvoid *opaque, const char *name)
466
467
468
469
470
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* WAD_openWrite */
471
static fvoid *WAD_openAppend(dvoid *opaque, const char *name)
472
473
474
475
476
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* WAD_openAppend */
477
static int WAD_remove(dvoid *opaque, const char *name)
478
479
480
481
482
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* WAD_remove */
483
static int WAD_mkdir(dvoid *opaque, const char *name)
484
485
486
487
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* WAD_mkdir */
488
489
490
491
const PHYSFS_ArchiveInfo __PHYSFS_ArchiveInfo_WAD =
{
"WAD",
492
WAD_ARCHIVE_DESCRIPTION,
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
"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 */
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 */
};
523
524
525
#endif /* defined PHYSFS_SUPPORTS_WAD */
/* end of wad.c ... */