libgm 0.7.1

A tool for unpacking and modding GameMaker games
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

// SPDX-License-Identifier: GPL-3.0-only
use crate::gml::Instruction;
use crate::gml::instruction::CodeVariable;
use crate::gml::instruction::DataType;
use crate::prelude::GMRef;
use crate::wad::elem::function::Function;

/// A value to push to the stack.
/// Used in [`Push`] instructions.
///
/// [`Push`]: Instruction::Push
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum PushValue {
    Int16(i16),
    Int32(i32),
    Int64(i64),
    Double(f64),
    Bool(bool),
    String(GMRef<String>),
    Variable(CodeVariable),
    Function(GMRef<Function>),
}

impl PushValue {
    /// This value's [`DataType`].
    ///
    /// Note that functions are represented as `Int32`.
    /// Some variables are also represented as `Int32` (idk when tho).
    #[must_use]
    pub const fn data_type(&self) -> DataType {
        match self {
            Self::Int16(_) => DataType::Int16,
            Self::Int32(_) | Self::Function(_) => DataType::Int32,
            Self::Variable(var) if var.is_int32 => DataType::Int32,
            Self::Int64(_) => DataType::Int64,
            Self::Double(_) => DataType::Double,
            Self::Bool(_) => DataType::Bool,
            Self::String(_) => DataType::String,
            Self::Variable(_) => DataType::Variable,
        }
    }

    /// An approximate boolean representation for this [`PushValue`].
    ///
    /// Warning: This function does not fully conform with the GameMaker
    /// standards (yet).
    #[must_use]
    pub(crate) const fn as_bool(&self) -> Option<bool> {
        match self {
            &Self::Int16(int) => Some(int > 0),
            &Self::Int32(int) => Some(int > 0),
            &Self::Int64(int) => Some(int > 0),
            &Self::Double(float) => Some(float > 0.5),
            &Self::Bool(bool) => Some(bool),
            Self::String(_) | Self::Function(_) | Self::Variable(_) => None,
        }
    }
}

impl Instruction {
    /// Attempts to extract a [`PushValue`] from this instruction.
    #[must_use]
    pub const fn push_value(&self) -> Option<PushValue> {
        Some(match *self {
            Self::Push { value } => value,
            Self::PushLocal { variable }
            | Self::PushGlobal { variable }
            | Self::PushBuiltin { variable } => PushValue::Variable(variable),
            Self::PushImmediate { integer } => PushValue::Int16(integer),
            _ => return None,
        })
    }
}