quake-util 0.4.0

A utility library for using Quake file formats
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

use std::mem::size_of;
use std::mem::MaybeUninit;

pub const BSP_VERSION: u32 = 29;
pub const BSP2_VERSION: u32 = u32::from_le_bytes(*b"BSP2");
pub const ENTRY_COUNT: usize = 15;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(usize)]
pub enum EntryOffset {
    Entities = 0,
    Planes,
    Textures,
    Vertices,
    Vis,
    Nodes,
    TexInfo,
    Faces,
    Light,
    ClipNodes,
    Leaves,
    MarkSurfaces,
    Edges,
    SurfEdges,
    Models,
}

impl From<EntryOffset> for usize {
    fn from(offset: EntryOffset) -> Self {
        offset as usize
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(C, packed)]
pub struct Entry {
    pub offset: u32,
    pub length: u32,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(C, packed)]
pub struct Head {
    version: u32,
    entries: [Entry; ENTRY_COUNT],
}

impl Head {
    pub fn entry(&self, offset: EntryOffset) -> Entry {
        let idx: usize = offset.into();
        self.entries[idx]
    }

    pub fn version(&self) -> u32 {
        self.version
    }
}

impl TryFrom<[u8; size_of::<Head>()]> for Head {
    type Error = crate::BinParseError;

    fn try_from(bytes: [u8; size_of::<Head>()]) -> crate::BinParseResult<Head> {
        let version =
            u32::from_le_bytes(<[u8; 4]>::try_from(&bytes[..4]).unwrap());

        if version != BSP_VERSION && version != BSP2_VERSION {
            return Err(crate::BinParseError::Parse(format!(
                "Unrecognized BSP version {} ({:?})",
                version,
                version.to_le_bytes(),
            )));
        }

        let rest = &bytes[4..];
        let mut entries = [MaybeUninit::<Entry>::uninit(); ENTRY_COUNT];

        for (idx, chunk) in rest.chunks(size_of::<Entry>()).enumerate() {
            entries[idx] = MaybeUninit::new(Entry {
                offset: u32::from_le_bytes(
                    <[u8; 4]>::try_from(&chunk[..4]).unwrap(),
                ),
                length: u32::from_le_bytes(
                    <[u8; 4]>::try_from(&chunk[4..]).unwrap(),
                ),
            });
        }

        let entries = entries.map(|entry| unsafe { entry.assume_init() });

        Ok(Head { version, entries })
    }
}