luars 0.17.0

A library for lua 5.5 runtime implementation in Rust
Documentation
use crate::LuaValue;

// Port of expdesc from lcode.h
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ExpKind {
    VVOID,  // when 'expdesc' describes the last expression of a list, this kind means an empty list
    VNIL,   // constant nil
    VTRUE,  // constant true
    VFALSE, // constant false
    VK,     // constant in 'k'; info = index of constant in 'k'
    VKFLT,  // floating constant; nval = numerical float value
    VKINT,  // integer constant; ival = numerical integer value
    VKSTR,  // string constant; strval = TString address
    VNONRELOC, // expression has its value in a fixed register; info = result register
    VLOCAL, // local variable; var.ridx = register index; var.vidx = relative index in 'actvar.arr'
    VVARGVAR, // vararg parameter; var.ridx = register index; var.vidx = relative index in 'actvar.arr'
    VUPVAL,   // upvalue variable; info = index of upvalue in 'upvalues'
    VCONST,   // compile-time <const> variable; info = absolute index in 'actvar.arr'
    VGLOBAL,  // Lua 5.5: global variable declaration; info = index in actvar for global name
    VINDEXED, // indexed variable; ind.t = table register; ind.idx = key's R index
    VINDEXUP, // indexed upvalue; ind.t = upvalue; ind.idx = key's K index
    VINDEXI, // indexed variable with constant integer; ind.t = table register; ind.idx = key's value
    VINDEXSTR, // indexed variable with literal string; ind.t = table register; ind.idx = key's K index
    VVARGIND, // indexed vararg parameter; ind.t = vararg register; ind.idx = key's R index (Lua 5.5)
    VJMP,     // expression is a test/comparison; info = pc of corresponding jump instruction
    VRELOC,   // expression can put result in any register; info = instruction pc
    VCALL,    // expression is a function call; info = instruction pc
    VVARARG,  // vararg expression; info = instruction pc
}

#[derive(Clone)]
pub struct ExpDesc {
    pub kind: ExpKind,
    pub u: ExpUnion,
    pub t: isize, // patch list of 'exit when true'
    pub f: isize, // patch list of 'exit when false'
}

#[derive(Clone, Copy)]
pub enum ExpUnion {
    // for generic use
    Info(i32),
    // for VKSTR
    Str(LuaValue),
    // for VKINT
    IVal(i64),
    // for VKFLT
    NVal(f64),
    // for indexed variables
    Ind(IndVars),
    // for local/upvalue variables
    Var(VarVals),
}

impl ExpUnion {
    pub fn info(&self) -> i32 {
        match self {
            ExpUnion::Info(info) => *info,
            _ => panic!("ExpUnion does not contain info"),
        }
    }

    pub fn str(&self) -> &LuaValue {
        match self {
            ExpUnion::Str(s_value) => s_value,
            _ => panic!("ExpUnion does not contain str"),
        }
    }

    pub fn ival(&self) -> i64 {
        match self {
            ExpUnion::IVal(ival) => *ival,
            _ => panic!("ExpUnion does not contain ival"),
        }
    }

    pub fn nval(&self) -> f64 {
        match self {
            ExpUnion::NVal(nval) => *nval,
            _ => panic!("ExpUnion does not contain nval"),
        }
    }

    pub fn ind(&self) -> IndVars {
        match self {
            ExpUnion::Ind(ind) => *ind,
            _ => panic!("ExpUnion does not contain ind"),
        }
    }

    pub fn ind_mut(&mut self) -> &mut IndVars {
        match self {
            ExpUnion::Ind(ind) => ind,
            _ => {
                *self = ExpUnion::Ind(IndVars {
                    t: -1,
                    idx: -1,
                    ro: false,
                    keystr: -1,
                });
                if let ExpUnion::Ind(ind) = self {
                    ind
                } else {
                    unreachable!()
                }
            }
        }
    }

    pub fn var(&self) -> VarVals {
        match self {
            ExpUnion::Var(var) => *var,
            _ => panic!("ExpUnion does not contain var"),
        }
    }
}

#[derive(Clone, Copy)]
pub struct IndVars {
    pub t: i16,      // table (register or upvalue)
    pub idx: i16,    // index (R or "long" K)
    pub ro: bool,    // true if variable is read-only
    pub keystr: i32, // index in 'k' of string key, or -1 if not a string
}

#[derive(Clone, Copy)]
pub struct VarVals {
    pub ridx: i16, // register holding the variable
    pub vidx: u16, // compiler index (in 'actvar.arr' or 'upvalues')
}

impl ExpDesc {
    pub fn new_void() -> Self {
        ExpDesc {
            kind: ExpKind::VVOID,
            u: ExpUnion::Info(0),
            t: -1,
            f: -1,
        }
    }

    pub fn new_nil() -> Self {
        ExpDesc {
            kind: ExpKind::VNIL,
            u: ExpUnion::Info(0),
            t: -1,
            f: -1,
        }
    }

    pub fn new_int(val: i64) -> Self {
        ExpDesc {
            kind: ExpKind::VKINT,
            u: ExpUnion::IVal(val),
            t: -1,
            f: -1,
        }
    }

    pub fn new_float(val: f64) -> Self {
        ExpDesc {
            kind: ExpKind::VKFLT,
            u: ExpUnion::NVal(val),
            t: -1,
            f: -1,
        }
    }

    pub fn new_bool(val: bool) -> Self {
        ExpDesc {
            kind: if val { ExpKind::VTRUE } else { ExpKind::VFALSE },
            u: ExpUnion::Info(0),
            t: -1,
            f: -1,
        }
    }

    pub fn new_k(info: usize) -> Self {
        ExpDesc {
            kind: ExpKind::VK,
            u: ExpUnion::Info(info as i32),
            t: -1,
            f: -1,
        }
    }

    pub fn new_vkstr(s_value: LuaValue) -> Self {
        debug_assert!(s_value.is_string(), "Expected LuaValue to be a string");
        ExpDesc {
            kind: ExpKind::VKSTR,
            u: ExpUnion::Str(s_value),
            t: -1,
            f: -1,
        }
    }

    pub fn new_nonreloc(reg: u8) -> Self {
        ExpDesc {
            kind: ExpKind::VNONRELOC,
            u: ExpUnion::Info(reg as i32),
            t: -1,
            f: -1,
        }
    }

    pub fn new_local(ridx: u8, vidx: u16) -> Self {
        ExpDesc {
            kind: ExpKind::VLOCAL,
            u: ExpUnion::Var(VarVals {
                ridx: ridx as i16,
                vidx,
            }),
            t: -1,
            f: -1,
        }
    }

    pub fn new_upval(idx: u8) -> Self {
        ExpDesc {
            kind: ExpKind::VUPVAL,
            u: ExpUnion::Info(idx as i32),
            t: -1,
            f: -1,
        }
    }

    pub fn new_indexed(t: u8, idx: u8) -> Self {
        ExpDesc {
            kind: ExpKind::VINDEXED,
            u: ExpUnion::Ind(IndVars {
                t: t as i16,
                idx: idx as i16,
                ro: false,
                keystr: -1,
            }),
            t: -1,
            f: -1,
        }
    }

    pub fn new_reloc(pc: usize) -> Self {
        ExpDesc {
            kind: ExpKind::VRELOC,
            u: ExpUnion::Info(pc as i32),
            t: -1,
            f: -1,
        }
    }

    pub fn new_call(pc: usize) -> Self {
        ExpDesc {
            kind: ExpKind::VCALL,
            u: ExpUnion::Info(pc as i32),
            t: -1,
            f: -1,
        }
    }

    pub fn has_jumps(&self) -> bool {
        // Port of hasjumps macro from lcode.c:58
        // #define hasjumps(e) ((e)->t != (e)->f)
        self.t != self.f
    }

    pub fn is_const(&self) -> bool {
        matches!(
            self.kind,
            ExpKind::VNIL
                | ExpKind::VTRUE
                | ExpKind::VFALSE
                | ExpKind::VK
                | ExpKind::VKFLT
                | ExpKind::VKINT
                | ExpKind::VKSTR
        )
    }

    pub fn is_numeral(&self) -> bool {
        matches!(self.kind, ExpKind::VKINT | ExpKind::VKFLT) && !self.has_jumps()
    }
}