wow-mpq 0.6.2

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

//! (listfile) parsing functionality

use crate::Result;

/// Parse a (listfile) into individual filenames
///
/// The (listfile) format supports:
/// - One filename per line
/// - Comments starting with ';' or '#'
/// - Optional file metadata after ';' on each line
/// - Empty lines are ignored
pub fn parse_listfile(data: &[u8]) -> Result<Vec<String>> {
    let content = match std::str::from_utf8(data) {
        Ok(s) => s.to_string(),
        Err(_) => {
            // Try lossy conversion for files with invalid UTF-8
            log::warn!("(listfile) contains invalid UTF-8, using lossy conversion");
            String::from_utf8_lossy(data).into_owned()
        }
    };

    let files: Vec<String> = content
        .lines()
        .filter_map(|line| {
            let line = line.trim();

            // Skip empty lines and comments
            if line.is_empty() || line.starts_with(';') || line.starts_with('#') {
                return None;
            }

            // Handle semicolon-separated format (filename;metadata)
            let filename = if let Some(pos) = line.find(';') {
                line[..pos].trim()
            } else {
                line
            };

            // Skip if the result is empty
            if filename.is_empty() {
                None
            } else {
                Some(filename.to_string())
            }
        })
        .collect();

    log::debug!("Parsed {} files from (listfile)", files.len());
    Ok(files)
}

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

    #[test]
    fn test_parse_simple_listfile() {
        let content = b"file1.txt\nfile2.dat\nfile3.bin";
        let files = parse_listfile(content).unwrap();
        assert_eq!(files.len(), 3);
        assert_eq!(files[0], "file1.txt");
        assert_eq!(files[1], "file2.dat");
        assert_eq!(files[2], "file3.bin");
    }

    #[test]
    fn test_parse_listfile_with_comments() {
        let content = b"; This is a comment\n\
                       file1.txt\n\
                       # Another comment\n\
                       file2.dat\n\
                       ; file3.txt - commented out\n\
                       file4.bin";

        let files = parse_listfile(content).unwrap();
        assert_eq!(files.len(), 3);
        assert_eq!(files[0], "file1.txt");
        assert_eq!(files[1], "file2.dat");
        assert_eq!(files[2], "file4.bin");
    }

    #[test]
    fn test_parse_listfile_with_metadata() {
        let content = b"file1.txt;12345\n\
                       file2.dat;67890;extra data\n\
                       file3.bin";

        let files = parse_listfile(content).unwrap();
        assert_eq!(files.len(), 3);
        assert_eq!(files[0], "file1.txt");
        assert_eq!(files[1], "file2.dat");
        assert_eq!(files[2], "file3.bin");
    }

    #[test]
    fn test_parse_empty_listfile() {
        let content = b"";
        let files = parse_listfile(content).unwrap();
        assert_eq!(files.len(), 0);
    }

    #[test]
    fn test_parse_listfile_only_comments() {
        let content = b"; Comment 1\n# Comment 2\n; Comment 3";
        let files = parse_listfile(content).unwrap();
        assert_eq!(files.len(), 0);
    }

    #[test]
    fn test_parse_listfile_with_empty_lines() {
        let content = b"file1.txt\n\n\nfile2.dat\n\n";
        let files = parse_listfile(content).unwrap();
        assert_eq!(files.len(), 2);
        assert_eq!(files[0], "file1.txt");
        assert_eq!(files[1], "file2.dat");
    }

    #[test]
    fn test_parse_listfile_with_whitespace() {
        let content = b"  file1.txt  \n\tfile2.dat\t\n   file3.bin   ;   metadata   ";
        let files = parse_listfile(content).unwrap();
        assert_eq!(files.len(), 3);
        assert_eq!(files[0], "file1.txt");
        assert_eq!(files[1], "file2.dat");
        assert_eq!(files[2], "file3.bin");
    }
}