whiteoutlib 0.1.5

Read and write Blizzard game assets from Rust: models (MDX, M2, M3), textures (BLP, DDS, PNG, JPEG, BMP, TGA, TIFF, GIF) and archives (CASC, MPQ).
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

// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 2026 Fernando Sahmkow

/// @file special_files.h
/// @brief MPQ special file parsing and building: (listfile), (attributes).

#pragma once

#include <whiteout/common_types.h>

#include <span>
#include <string>
#include <vector>

namespace whiteout::storages::mpq {

// ============================================================================
// (attributes) Flags
// ============================================================================

enum class AttributeFlag : u32 {
    None = 0,
    kCrc32 = 0x00000001,    ///< CRC32 array is present.
    kFiletime = 0x00000002, ///< FILETIME array is present.
    kMd5 = 0x00000004,      ///< MD5 array is present.
};

inline AttributeFlag operator|(AttributeFlag a, AttributeFlag b) noexcept {
    return static_cast<AttributeFlag>(static_cast<u32>(a) | static_cast<u32>(b));
}
inline AttributeFlag operator&(AttributeFlag a, AttributeFlag b) noexcept {
    return static_cast<AttributeFlag>(static_cast<u32>(a) & static_cast<u32>(b));
}
inline AttributeFlag& operator|=(AttributeFlag& a, AttributeFlag b) noexcept {
    a = a | b;
    return a;
}
inline bool hasFlag(AttributeFlag flags, AttributeFlag flag) noexcept {
    return (flags & flag) != AttributeFlag::None;
}

// ============================================================================
// (listfile)
// ============================================================================

/// Parse a `(listfile)` file into a list of filenames.
/// Splits on CR/LF, skips empty lines and lines starting with `;` or `#`.
[[nodiscard]] std::vector<std::string> parseListfile(std::span<const u8> data);

/// Build a `(listfile)` from a list of filenames.
/// Produces CRLF-separated output.
[[nodiscard]] std::vector<u8> buildListfile(const std::vector<std::string>& filenames);

// ============================================================================
// (attributes)
// ============================================================================

/// Per-file attributes from `(attributes)`.
struct FileAttributes {
    std::vector<u32> crc32s;              ///< CRC32 per block entry.
    std::vector<u64> filetimes;           ///< FILETIME per block entry.
    std::vector<std::array<u8, 16>> md5s; ///< MD5 per block entry.
};

/// Parse `(attributes)` file data.
/// @param data       Raw (attributes) file content.
/// @param blockCount Number of block table entries (determines array sizes).
[[nodiscard]] FileAttributes parseAttributes(std::span<const u8> data, u32 blockCount);

/// Build an `(attributes)` file from per-file data.
/// @param attrs   The attributes to serialize.
/// @param version Attributes version (typically 100).
[[nodiscard]] std::vector<u8> buildAttributes(const FileAttributes& attrs, u32 version = 100);

} // namespace whiteout::storages::mpq