wow-mpq 0.6.4

High-performance parser for World of Warcraft MPQ archives with parallel processing support
Documentation 
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
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
240
241
242
243
244
245
246
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344

//! I/O abstractions for MPQ archives

#[cfg(feature = "async")]
pub mod async_reader;
pub mod memory_map;

use crate::Result;
use std::io::{Read, Seek, SeekFrom};

#[cfg(feature = "async")]
pub use async_reader::{
    AsyncArchiveReader, AsyncConfig, AsyncDecompressionMonitor, AsyncMetrics, AsyncOperationStats,
};

pub use memory_map::{MemoryMapConfig, MemoryMapStats};

#[cfg(feature = "mmap")]
pub use memory_map::{MemoryMapManager, MemoryMappedArchive};

/// Trait for reading from MPQ archives
pub trait MpqRead: Read + Seek {
    /// Read exact number of bytes at the given offset
    fn read_at(&mut self, offset: u64, buf: &mut [u8]) -> Result<()>;
}

/// Buffered reader for MPQ archives
#[derive(Debug)]
pub struct BufferedMpqReader<R> {
    inner: R,
}

impl<R: Read + Seek> BufferedMpqReader<R> {
    /// Create a new buffered reader
    pub fn new(inner: R) -> Self {
        Self { inner }
    }
}

impl<R: Read + Seek> MpqRead for BufferedMpqReader<R> {
    fn read_at(&mut self, offset: u64, buf: &mut [u8]) -> Result<()> {
        self.inner.seek(SeekFrom::Start(offset))?;
        self.inner.read_exact(buf)?;
        Ok(())
    }
}

impl<R: Read> Read for BufferedMpqReader<R> {
    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
        self.inner.read(buf)
    }
}

impl<R: Seek> Seek for BufferedMpqReader<R> {
    fn seek(&mut self, pos: std::io::SeekFrom) -> std::io::Result<u64> {
        self.inner.seek(pos)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Cursor;

    #[test]
    fn test_buffered_mpq_reader_creation() {
        let data = vec![1, 2, 3, 4, 5];
        let cursor = Cursor::new(data.clone());
        let reader = BufferedMpqReader::new(cursor);

        // Verify we can access the inner reader
        assert_eq!(reader.inner.get_ref(), &data);
    }

    #[test]
    fn test_read_at() {
        let data = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        let mut buf = [0u8; 3];
        reader.read_at(2, &mut buf).unwrap();
        assert_eq!(buf, [2, 3, 4]);

        let mut buf = [0u8; 2];
        reader.read_at(8, &mut buf).unwrap();
        assert_eq!(buf, [8, 9]);

        let mut buf = [0u8; 1];
        reader.read_at(0, &mut buf).unwrap();
        assert_eq!(buf, [0]);
    }

    #[test]
    fn test_read_at_multiple_calls() {
        let data = vec![10, 20, 30, 40, 50, 60, 70, 80, 90, 100];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        let mut buf1 = [0u8; 2];
        let mut buf2 = [0u8; 3];
        let mut buf3 = [0u8; 1];

        reader.read_at(1, &mut buf1).unwrap();
        assert_eq!(buf1, [20, 30]);

        reader.read_at(5, &mut buf2).unwrap();
        assert_eq!(buf2, [60, 70, 80]);

        reader.read_at(9, &mut buf3).unwrap();
        assert_eq!(buf3, [100]);
    }

    #[test]
    fn test_read_at_out_of_bounds() {
        let data = vec![1, 2, 3];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        // This should succeed - reading last byte and one past
        let mut buf = [0u8; 2];
        let result = reader.read_at(2, &mut buf);
        assert!(result.is_err()); // Can't read 2 bytes starting at position 2 from 3-byte data

        // This should definitely fail - starting beyond the data
        let mut buf = [0u8; 1];
        let result = reader.read_at(3, &mut buf);
        assert!(result.is_err());
    }

    #[test]
    fn test_read_trait() {
        let data = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        let mut buf = [0u8; 3];
        let bytes_read = reader.read(&mut buf).unwrap();
        assert_eq!(bytes_read, 3);
        assert_eq!(buf, [1, 2, 3]);

        let mut buf = [0u8; 4];
        let bytes_read = reader.read(&mut buf).unwrap();
        assert_eq!(bytes_read, 4);
        assert_eq!(buf, [4, 5, 6, 7]);
    }

    #[test]
    fn test_read_empty_buffer() {
        let data = vec![1, 2, 3];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        let mut buf = [0u8; 0];
        let bytes_read = reader.read(&mut buf).unwrap();
        assert_eq!(bytes_read, 0);
    }

    #[test]
    fn test_read_past_end() {
        let data = vec![1, 2, 3];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        let mut buf = [0u8; 5];
        let bytes_read = reader.read(&mut buf).unwrap();
        assert_eq!(bytes_read, 3);
        assert_eq!(&buf[..3], &[1, 2, 3]);

        let bytes_read = reader.read(&mut buf).unwrap();
        assert_eq!(bytes_read, 0);
    }

    #[test]
    fn test_seek_trait() {
        let data = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        let pos = reader.seek(SeekFrom::Start(5)).unwrap();
        assert_eq!(pos, 5);

        let mut buf = [0u8; 2];
        reader.read_exact(&mut buf).unwrap();
        assert_eq!(buf, [5, 6]);

        let pos = reader.seek(SeekFrom::Current(-3)).unwrap();
        assert_eq!(pos, 4);

        reader.read_exact(&mut buf).unwrap();
        assert_eq!(buf, [4, 5]);

        let pos = reader.seek(SeekFrom::End(-2)).unwrap();
        assert_eq!(pos, 8);

        reader.read_exact(&mut buf).unwrap();
        assert_eq!(buf, [8, 9]);
    }

    #[test]
    fn test_seek_beyond_bounds() {
        let data = vec![1, 2, 3, 4, 5];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        let pos = reader.seek(SeekFrom::Start(10)).unwrap();
        assert_eq!(pos, 10);

        let mut buf = [0u8; 1];
        let bytes_read = reader.read(&mut buf).unwrap();
        assert_eq!(bytes_read, 0);
    }

    #[test]
    fn test_seek_negative_position() {
        let data = vec![1, 2, 3, 4, 5];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        reader.seek(SeekFrom::Start(2)).unwrap();

        let result = reader.seek(SeekFrom::Current(-5));
        assert!(result.is_err());
    }

    #[test]
    fn test_combined_operations() {
        let data = vec![10, 20, 30, 40, 50, 60, 70, 80, 90, 100];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        // Read first 2 bytes: position goes from 0 to 2
        let mut buf = [0u8; 2];
        reader.read_exact(&mut buf).unwrap();
        assert_eq!(buf, [10, 20]);

        // Seek forward 3 bytes: position goes from 2 to 5
        reader.seek(SeekFrom::Current(3)).unwrap();
        reader.read_exact(&mut buf).unwrap();
        assert_eq!(buf, [60, 70]);

        // read_at doesn't change the current position, but after read_at seeks to offset
        let mut buf = [0u8; 3];
        reader.read_at(1, &mut buf).unwrap();
        assert_eq!(buf, [20, 30, 40]);

        // After read_at, the position is at 4 (1 + 3 bytes read)
        reader.read_exact(&mut buf).unwrap();
        assert_eq!(buf, [50, 60, 70]);
    }

    #[test]
    fn test_large_buffer_read() {
        let mut data = Vec::new();
        for i in 0..1000 {
            data.push((i % 256) as u8);
        }

        let cursor = Cursor::new(data.clone());
        let mut reader = BufferedMpqReader::new(cursor);

        let mut buf = vec![0u8; 1000];
        reader.read_at(0, &mut buf).unwrap();
        assert_eq!(buf, data);

        let mut buf = vec![0u8; 500];
        reader.read_at(250, &mut buf).unwrap();
        assert_eq!(buf, data[250..750]);
    }

    #[test]
    fn test_zero_length_read_at() {
        let data = vec![1, 2, 3, 4, 5];
        let cursor = Cursor::new(data);
        let mut reader = BufferedMpqReader::new(cursor);

        let buf = &mut [];
        let result = reader.read_at(2, buf);
        assert!(result.is_ok());
    }

    struct MockSeekRead {
        data: Vec<u8>,
        position: usize,
        read_count: std::cell::Cell<usize>,
        seek_count: std::cell::Cell<usize>,
    }

    impl MockSeekRead {
        fn new(data: Vec<u8>) -> Self {
            Self {
                data,
                position: 0,
                read_count: std::cell::Cell::new(0),
                seek_count: std::cell::Cell::new(0),
            }
        }
    }

    impl Read for MockSeekRead {
        fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
            self.read_count.set(self.read_count.get() + 1);
            let available = self.data.len().saturating_sub(self.position);
            let to_read = buf.len().min(available);
            buf[..to_read].copy_from_slice(&self.data[self.position..self.position + to_read]);
            self.position += to_read;
            Ok(to_read)
        }
    }

    impl Seek for MockSeekRead {
        fn seek(&mut self, pos: SeekFrom) -> std::io::Result<u64> {
            self.seek_count.set(self.seek_count.get() + 1);
            match pos {
                SeekFrom::Start(offset) => {
                    self.position = offset as usize;
                    Ok(offset)
                }
                SeekFrom::Current(offset) => {
                    let new_pos = (self.position as i64 + offset).max(0) as usize;
                    self.position = new_pos;
                    Ok(new_pos as u64)
                }
                SeekFrom::End(offset) => {
                    let new_pos = (self.data.len() as i64 + offset).max(0) as usize;
                    self.position = new_pos;
                    Ok(new_pos as u64)
                }
            }
        }
    }

    #[test]
    fn test_read_at_calls_seek_and_read() {
        let mock = MockSeekRead::new(vec![1, 2, 3, 4, 5]);
        let mut reader = BufferedMpqReader::new(mock);

        let mut buf = [0u8; 2];
        reader.read_at(2, &mut buf).unwrap();

        assert_eq!(reader.inner.seek_count.get(), 1);
        assert_eq!(reader.inner.read_count.get(), 1);
        assert_eq!(buf, [3, 4]);
    }
}