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
use std::io::Cursor;
use std::path::Path;
use byteorder::{LittleEndian, ReadBytesExt};
const HEADER_BYTE_SIZE: usize = 12;
const DIRECTORY_ENTRY_BYTE_SIZE: usize = 16;
#[derive(Debug, Copy, Clone)]
pub enum Kind {
IWad,
PWad,
}
#[derive(Debug)]
pub enum Error {
Invalid,
InvalidLength,
InvalidHeader,
InvalidEntry,
OutOfBounds,
}
impl std::fmt::Display for Error {
fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(fmt, "{}", match self {
Error::Invalid => "Invalid WAD file",
Error::InvalidLength => "Invalid WAD file length",
Error::InvalidHeader => "Invalid WAD file header",
Error::InvalidEntry => "Invalid WAD file entry",
Error::OutOfBounds => "Index out of bounds",
})
}
}
impl std::error::Error for Error {
}
macro_rules! verify {
($condition:expr, $err:expr) => {
if !$condition {
return Err($err);
}
};
}
#[derive(Debug)]
pub enum LoadError {
Error(Error),
IoError(std::io::Error),
}
impl std::fmt::Display for LoadError {
fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
LoadError::Error(e) => write!(fmt, "{}", e),
LoadError::IoError(e) => write!(fmt, "{}", e),
}
}
}
impl std::error::Error for LoadError {
}
pub struct Wad {
kind: Kind,
data: Vec<u8>,
directory_offset: usize,
n_entries: usize,
}
impl Wad {
pub fn kind(&self) -> Kind {
self.kind
}
pub fn len(&self) -> usize {
self.n_entries
}
pub fn entry(&self, index: usize) -> Result<(&str, &[u8]), Error> {
verify!(index < self.len(), Error::OutOfBounds);
let dir_entry_start = self.directory_offset +
DIRECTORY_ENTRY_BYTE_SIZE * index;
let directory_entry = &self.data[
dir_entry_start
..
dir_entry_start + DIRECTORY_ENTRY_BYTE_SIZE
];
let mut rdr = Cursor::new(directory_entry);
let start = rdr.read_i32::<LittleEndian>().expect("Struct invariant");
let length = rdr.read_i32::<LittleEndian>().expect("Struct invariant");
verify!(length >= 0, Error::InvalidEntry);
let length = length as usize;
verify!(start >= 0, Error::InvalidEntry);
let mut start = start as usize;
if length == 0 {
start = HEADER_BYTE_SIZE;
}
verify!(start >= HEADER_BYTE_SIZE, Error::InvalidEntry);
let end = start.checked_add(length).ok_or(Error::InvalidEntry)?;
verify!(end <= self.directory_offset, Error::InvalidEntry);
let lump = &self.data[start..end];
let name = &directory_entry[8..16];
let name = name.split(|&x| x == 0).next().ok_or(Error::InvalidEntry)?;
verify!(name.len() > 0, Error::InvalidEntry);
verify!(name.iter().all(|&x| x & 0x80 == 0), Error::InvalidEntry);
let name = std::str::from_utf8(name).unwrap();
Ok((name, lump))
}
pub fn iter(&self) -> WadIterator {
WadIterator::new(self)
}
}
pub struct WadIterator<'a> {
index: usize,
wad: &'a Wad,
}
impl<'a> WadIterator<'a> {
fn new<'b>(wad: &'b Wad) -> WadIterator<'b> {
WadIterator {
index: 0,
wad,
}
}
}
impl<'a> Iterator for WadIterator<'a> {
type Item = (&'a str, &'a [u8]);
fn next(&mut self) -> Option<Self::Item> {
if self.index < self.wad.len() {
self.index += 1;
return Some(self.wad.entry(self.index - 1).unwrap());
} else {
return None;
}
}
}
impl std::ops::Index<usize> for Wad {
type Output = [u8];
fn index(&self, index: usize) -> &Self::Output {
self.entry(index).unwrap().1
}
}
pub fn parse_wad(mut data: Vec<u8>) -> Result<Wad, Error> {
if data.len() < HEADER_BYTE_SIZE {
return Err(Error::InvalidLength);
}
let kind = match &data[0..4] {
b"IWAD" => Ok(Kind::IWad),
b"PWAD" => Ok(Kind::PWad),
_ => Err(Error::InvalidHeader),
}?;
let mut rdr = Cursor::new(&data[4..12]);
let n_entries = rdr.read_i32::<LittleEndian>().expect("Checked by guard at top");
let directory_offset = rdr.read_i32::<LittleEndian>().expect("Checked by guard at top");
if n_entries < 0 || directory_offset < 0 {
return Err(Error::Invalid);
}
let n_entries = n_entries as usize;
let directory_offset = directory_offset as usize;
let expected_directory_length = n_entries
.checked_mul(DIRECTORY_ENTRY_BYTE_SIZE)
.ok_or(Error::Invalid)?;
let expected_binary_length = directory_offset
.checked_add(expected_directory_length)
.ok_or(Error::Invalid)?;
if data.len() < expected_binary_length {
return Err(Error::InvalidLength);
}
data.truncate(expected_binary_length);
Ok(Wad {
kind,
data,
directory_offset,
n_entries,
})
}
pub fn load_wad_file(filename: impl AsRef<Path>)
-> Result<Wad, LoadError>
{
let data = std::fs::read(filename).map_err(LoadError::IoError)?;
parse_wad(data).map_err(LoadError::Error)
}