opcode.rs

// Copyright (C) 2024 Ryan Daum <ryan.daum@gmail.com>
//
// This program is free software: you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free Software
// Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with
// this program. If not, see <https://www.gnu.org/licenses/>.
//

use bincode::{Decode, Encode};
use moor_values::var::Error;
use moor_values::var::Objid;

use crate::labels::{Label, Name, Offset};

#[derive(Clone, Debug, PartialEq, Eq, Ord, PartialOrd, Encode, Decode)]
pub enum Op {
    Add,
    And(Label),
    CallVerb,
    Catch(Label),
    CheckListForSplice,
    Continue,
    Div,
    Done,
    Eif(Label),
    EndCatch(Label),
    EndExcept(Label),
    EndFinally,
    Eq,
    Exit { stack: Offset, label: Label },
    ExitId(Label),
    Exp,
    ForList { id: Name, end_label: Label },
    ForRange { id: Name, end_label: Label },
    Fork { fv_offset: Offset, id: Option<Name> },
    FuncCall { id: Name },
    GPush { id: Name },
    GPut { id: Name },
    Ge,
    GetProp,
    Gt,
    IfQues(Label),
    Imm(Label),
    ImmBigInt(i64),
    ImmEmptyList,
    ImmErr(Error),
    ImmInt(i32),
    ImmNone,
    ImmObjid(Objid),
    In,
    IndexSet,
    Jump { label: Label },
    Le,
    Length(Offset),
    ListAddTail,
    ListAppend,
    Lt,
    MakeSingletonList,
    Mod,
    Mul,
    Ne,
    Not,
    Or(Label),
    Pass,
    Pop,
    Push(Name),
    PushGetProp,
    PushLabel(Label),
    PushRef,
    PushTemp,
    Put(Name),
    PutProp,
    PutTemp,
    RangeRef,
    RangeSet,
    Ref,
    Return,
    Return0,
    Scatter(Box<ScatterArgs>),
    Sub,
    TryExcept { num_excepts: usize },
    TryFinally(Label),
    UnaryMinus,
    While(Label),
    WhileId { id: Name, end_label: Label },
    If(Label),
}

#[derive(Clone, Debug, PartialEq, Eq, Ord, PartialOrd, Encode, Decode)]
pub enum ScatterLabel {
    Optional(Name, Option<Label>),
    Required(Name),
    Rest(Name),
}

#[derive(Clone, Debug, PartialEq, Eq, Ord, PartialOrd, Encode, Decode)]
pub struct ScatterArgs {
    pub nargs: usize,
    pub nreq: usize,
    pub rest: usize,
    pub labels: Vec<ScatterLabel>,
    pub done: Label,
}

#[cfg(test)]
mod tests {
    use crate::{Label, Name, Offset};

    /// Verify we don't go over our 16 byte budget for opcodes.
    // TODO(rdaum): This is still rather bloated.
    #[test]
    fn size_opcode() {
        use crate::opcode::Op;
        use std::mem::size_of;
        assert_eq!(size_of::<Op>(), 16);
        assert_eq!(size_of::<Name>(), 2);
        assert_eq!(size_of::<Offset>(), 2);
        assert_eq!(size_of::<Label>(), 2);
    }
}