whiteoutlib 0.1.3

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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

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

#include <whiteout/models/wem/parser.h>

#include "../../common/binary_reader.h"
#include "../../common/streams.h"
#include "../../common/unicode_path.h"

#include "binary_parse_visitor.h"

#include <fstream>

namespace whiteout {
namespace models {
namespace wem {

using common::BinaryReader;

// ============================================================================
// ParserImpl
// ============================================================================

class Parser::Impl {
public:
    std::vector<std::string> issues;

    std::optional<Model> parse(BinaryReader& reader) {
        issues.clear();
        Model model;
        BinaryParseVisitor visitor(reader);
        visitor.read(model);

        for (const auto& issue : visitor.getIssues()) {
            reportIssue(issue);
        }

        // If the visitor reported fatal issues, return nullopt.
        for (const auto& issue : issues) {
            if (issue.find("Invalid WEM") != std::string::npos ||
                issue.find("no model data") != std::string::npos ||
                issue.find("index out of bounds") != std::string::npos) {
                return std::nullopt;
            }
        }

        return model;
    }

private:
    void reportIssue(const std::string& message) {
        issues.push_back(message);
    }
};

// ============================================================================
// Parser Public Interface
// ============================================================================

Parser::Parser() : pImpl(std::make_unique<Impl>()) {}

Parser::~Parser() = default;

std::optional<Model> Parser::parse(const std::string& filePath) {
    auto file = common::open_ifstream(filePath, std::ios::binary);
    if (!file.is_open()) {
        pImpl->issues.push_back("Failed to open file: " + filePath);
        return std::nullopt;
    }
    BinaryReader reader(file);
    return pImpl->parse(reader);
}

std::optional<Model> Parser::parse(std::span<const u8> buffer) {
    common::span_streambuf streambuf(buffer);
    std::istream in(&streambuf);
    BinaryReader reader(in);
    return pImpl->parse(reader);
}

bool Parser::hasIssues() const {
    return !pImpl->issues.empty();
}

const std::vector<std::string>& Parser::getIssues() const {
    return pImpl->issues;
}

} // namespace wem
} // namespace models
} // namespace whiteout