/
archiver_wad.c
516 lines (410 loc) · 13.8 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
PHYSFS_uint32 startPos;
PHYSFS_uint32 size;
} WADentry;
typedef struct
{
char *filename;
PHYSFS_uint32 entryCount;
PHYSFS_uint32 entryOffset;
WADentry *entries;
} WADinfo;
typedef struct
{
void *handle;
WADentry *entry;
PHYSFS_uint32 curPos;
} WADfileinfo;
78
static void WAD_dirClose(dvoid *opaque)
79
{
80
WADinfo *info = ((WADinfo *) opaque);
81
82
83
allocator.Free(info->filename);
allocator.Free(info->entries);
allocator.Free(info);
84
85
86
} /* WAD_dirClose */
87
static PHYSFS_sint64 WAD_read(fvoid *opaque, void *buffer, PHYSFS_uint64 len)
88
{
89
WADfileinfo *finfo = (WADfileinfo *) opaque;
90
91
const WADentry *entry = finfo->entry;
const PHYSFS_uint64 bytesLeft = (PHYSFS_uint64)(entry->size-finfo->curPos);
92
93
PHYSFS_sint64 rc;
94
95
if (bytesLeft < len)
len = bytesLeft;
96
97
rc = __PHYSFS_platformRead(finfo->handle, buffer, len);
98
if (rc > 0)
99
finfo->curPos += (PHYSFS_uint32) rc;
100
101
return rc;
102
103
104
} /* WAD_read */
105
static PHYSFS_sint64 WAD_write(fvoid *f, const void *buf, PHYSFS_uint64 len)
106
107
108
109
110
{
BAIL_MACRO(ERR_NOT_SUPPORTED, -1);
} /* WAD_write */
111
static int WAD_eof(fvoid *opaque)
112
{
113
WADfileinfo *finfo = (WADfileinfo *) opaque;
114
WADentry *entry = finfo->entry;
115
return (finfo->curPos >= entry->size);
116
117
118
} /* WAD_eof */
119
static PHYSFS_sint64 WAD_tell(fvoid *opaque)
120
{
121
return ((WADfileinfo *) opaque)->curPos;
122
123
124
} /* WAD_tell */
125
static int WAD_seek(fvoid *opaque, PHYSFS_uint64 offset)
126
{
127
WADfileinfo *finfo = (WADfileinfo *) opaque;
128
129
130
131
132
133
134
135
136
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;
137
return rc;
138
139
140
} /* WAD_seek */
141
static PHYSFS_sint64 WAD_fileLength(fvoid *opaque)
142
{
143
WADfileinfo *finfo = (WADfileinfo *) opaque;
144
return ((PHYSFS_sint64) finfo->entry->size);
145
146
147
} /* WAD_fileLength */
148
static int WAD_fileClose(fvoid *opaque)
149
{
150
WADfileinfo *finfo = (WADfileinfo *) opaque;
151
BAIL_IF_MACRO(!__PHYSFS_platformClose(finfo->handle), NULL, 0);
152
allocator.Free(finfo);
153
return 1;
154
155
156
} /* WAD_fileClose */
157
158
159
160
161
162
static inline int readAll(void *fh, void *buf, const PHYSFS_uint64 len)
{
return (__PHYSFS_platformRead(fh, buf, len) == len);
} /* readAll */
163
164
165
166
167
168
169
170
171
172
173
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);
174
if (!readAll(*fh, buf, 4))
175
176
177
178
179
180
181
182
goto openWad_failed;
if (memcmp(buf, "IWAD", 4) != 0 && memcmp(buf, "PWAD", 4) != 0)
{
__PHYSFS_setError(ERR_UNSUPPORTED_ARCHIVE);
goto openWad_failed;
} /* if */
183
if (!readAll(*fh, count, sizeof (PHYSFS_uint32)))
184
185
186
187
goto openWad_failed;
*count = PHYSFS_swapULE32(*count);
188
if (!readAll(*fh, offset, sizeof (PHYSFS_uint32)))
189
190
191
192
goto openWad_failed;
*offset = PHYSFS_swapULE32(*offset);
193
return 1;
194
195
196
197
198
199
200
openWad_failed:
if (*fh != NULL)
__PHYSFS_platformClose(*fh);
*count = -1;
*fh = NULL;
201
return 0;
202
203
204
205
206
} /* wad_open */
static int wad_entry_cmp(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
207
208
209
if (one != two)
{
const WADentry *a = (const WADentry *) _a;
210
return strcmp(a[one].name, a[two].name);
211
212
213
} /* if */
return 0;
214
215
216
217
218
} /* wad_entry_cmp */
static void wad_entry_swap(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
219
220
221
222
223
224
225
226
227
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 */
228
229
230
231
232
233
234
235
236
} /* 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;
237
char lastDirectory[9];
238
239
lastDirectory[8] = 0; /* Make sure lastDirectory stays null-terminated. */
240
241
242
BAIL_IF_MACRO(!wad_open(name, forWriting, &fh, &fileCount,&directoryOffset), NULL, 0);
info->entryCount = fileCount;
243
info->entries = (WADentry *) allocator.Malloc(sizeof(WADentry)*fileCount);
244
245
246
247
248
249
250
251
252
253
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++)
{
254
255
256
if ( (!readAll(fh, &entry->startPos, sizeof (PHYSFS_uint32))) ||
(!readAll(fh, &entry->size, sizeof (PHYSFS_uint32))) ||
(!readAll(fh, &entry->name, 8)) )
257
258
{
__PHYSFS_platformClose(fh);
259
return 0;
260
261
262
263
264
265
266
267
268
269
270
} /* 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);
271
return 1;
272
273
274
} /* wad_load_entries */
275
static void *WAD_openArchive(const char *name, int forWriting)
276
{
277
WADinfo *info = (WADinfo *) allocator.Malloc(sizeof (WADinfo));
278
279
BAIL_IF_MACRO(info == NULL, ERR_OUT_OF_MEMORY, NULL);
280
281
memset(info, '\0', sizeof (WADinfo));
282
info->filename = (char *) allocator.Malloc(strlen(name) + 1);
283
GOTO_IF_MACRO(!info->filename, ERR_OUT_OF_MEMORY, WAD_openArchive_failed);
284
285
286
287
288
if (!wad_load_entries(name, forWriting, info))
goto WAD_openArchive_failed;
strcpy(info->filename, name);
289
return info;
290
291
WAD_openArchive_failed:
292
if (info != NULL)
293
{
294
if (info->filename != NULL)
295
allocator.Free(info->filename);
296
if (info->entries != NULL)
297
298
allocator.Free(info->entries);
allocator.Free(info);
299
300
} /* if */
301
return NULL;
302
303
304
} /* WAD_openArchive */
305
static void WAD_enumerateFiles(dvoid *opaque, const char *dname,
306
307
int omitSymLinks, PHYSFS_EnumFilesCallback cb,
const char *origdir, void *callbackdata)
308
{
309
WADinfo *info = ((WADinfo *) opaque);
310
311
312
WADentry *entry = info->entries;
PHYSFS_uint32 max = info->entryCount;
PHYSFS_uint32 i;
313
const char *name;
314
char *sep;
315
316
if (*dname == '\0') /* root directory enumeration? */
317
318
319
{
for (i = 0; i < max; i++, entry++)
{
320
321
name = entry->name;
if (strchr(name, '/') == NULL)
322
cb(callbackdata, origdir, name);
323
324
325
326
327
328
} /* for */
} /* if */
else
{
for (i = 0; i < max; i++, entry++)
{
329
330
name = entry->name;
sep = strchr(name, '/');
331
332
if (sep != NULL)
{
333
if (strncmp(dname, name, (sep - name)) == 0)
334
cb(callbackdata, origdir, sep + 1);
335
336
337
} /* if */
} /* for */
} /* else */
338
339
340
} /* WAD_enumerateFiles */
341
static WADentry *wad_find_entry(const WADinfo *info, const char *name)
342
343
344
345
346
347
348
349
350
351
352
353
{
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! */
354
return &a[middle];
355
356
357
358
359
360
361
362
363
364
else if (rc > 0)
lo = middle + 1;
else
hi = middle - 1;
} /* while */
BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);
} /* wad_find_entry */
365
static int WAD_exists(dvoid *opaque, const char *name)
366
{
367
return (wad_find_entry((WADinfo *) opaque, name) != NULL);
368
369
370
} /* WAD_exists */
371
static int WAD_isDirectory(dvoid *opaque, const char *name, int *fileExists)
372
{
373
WADentry *entry = wad_find_entry(((WADinfo *) opaque), name);
374
375
376
377
378
379
380
381
if (entry != NULL)
{
char *n;
*fileExists = 1;
/* Can't be a directory if it's a subdirectory. */
if (strchr(entry->name, '/') != NULL)
382
return 0;
383
384
385
386
387
388
/* 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))
{
389
return 1;
390
} /* if */
391
return 0;
392
393
394
395
} /* if */
else
{
*fileExists = 0;
396
return 0;
397
} /* else */
398
399
400
} /* WAD_isDirectory */
401
static int WAD_isSymLink(dvoid *opaque, const char *name, int *fileExists)
402
{
403
*fileExists = WAD_exists(opaque, name);
404
return 0; /* never symlinks in a wad. */
405
406
407
} /* WAD_isSymLink */
408
static fvoid *WAD_openRead(dvoid *opaque, const char *fnm, int *fileExists)
409
{
410
WADinfo *info = ((WADinfo *) opaque);
411
412
413
414
415
416
417
WADfileinfo *finfo;
WADentry *entry;
entry = wad_find_entry(info, fnm);
*fileExists = (entry != NULL);
BAIL_IF_MACRO(entry == NULL, NULL, NULL);
418
finfo = (WADfileinfo *) allocator.Malloc(sizeof (WADfileinfo));
419
BAIL_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, NULL);
420
421
422
423
424
finfo->handle = __PHYSFS_platformOpenRead(info->filename);
if ( (finfo->handle == NULL) ||
(!__PHYSFS_platformSeek(finfo->handle, entry->startPos)) )
{
425
allocator.Free(finfo);
426
return NULL;
427
428
429
430
} /* if */
finfo->curPos = 0;
finfo->entry = entry;
431
return finfo;
432
433
434
} /* WAD_openRead */
435
static fvoid *WAD_openWrite(dvoid *opaque, const char *name)
436
437
438
439
440
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* WAD_openWrite */
441
static fvoid *WAD_openAppend(dvoid *opaque, const char *name)
442
443
444
445
446
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* WAD_openAppend */
447
static int WAD_remove(dvoid *opaque, const char *name)
448
449
450
451
452
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* WAD_remove */
453
static int WAD_mkdir(dvoid *opaque, const char *name)
454
455
456
457
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* WAD_mkdir */
458
459
static int WAD_stat(dvoid *opaque, const char *filename, int *exists,
460
461
462
463
464
465
466
467
468
469
470
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;
471
472
473
stat->accesstime = -1;
stat->modtime = -1;
stat->createtime = -1;
474
475
stat->readonly = 1; /* WADs are always readonly */
476
return 1;
477
478
479
} /* WAD_stat */
480
481
482
const PHYSFS_ArchiveInfo __PHYSFS_ArchiveInfo_WAD =
{
"WAD",
483
WAD_ARCHIVE_DESCRIPTION,
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
"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_exists, /* exists() method */
WAD_isDirectory, /* isDirectory() method */
WAD_isSymLink, /* isSymLink() 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 */
503
WAD_stat, /* stat() method */
504
505
506
507
508
509
WAD_read, /* read() method */
WAD_write, /* write() method */
WAD_eof, /* eof() method */
WAD_tell, /* tell() method */
WAD_seek, /* seek() method */
WAD_fileLength, /* fileLength() method */
510
WAD_fileClose /* fileClose() method */
511
512
};
513
514
515
#endif /* defined PHYSFS_SUPPORTS_WAD */
/* end of wad.c ... */