Enum bones_framework::prelude::piccolo::opcode::Operation

pub enum Operation {
    Move {
        dest: RegisterIndex,
        source: RegisterIndex,
    },
    LoadConstant {
        dest: RegisterIndex,
        constant: ConstantIndex16,
    },
    LoadBool {
        dest: RegisterIndex,
        value: bool,
        skip_next: bool,
    },
    LoadNil {
        dest: RegisterIndex,
        count: u8,
    },
    NewTable {
        dest: RegisterIndex,
        array_size: u8,
        map_size: u8,
    },
    GetTable {
        dest: RegisterIndex,
        table: RegisterIndex,
        key: RCIndex,
    },
    SetTable {
        table: RegisterIndex,
        key: RCIndex,
        value: RCIndex,
    },
    GetUpTable {
        dest: RegisterIndex,
        table: UpValueIndex,
        key: RCIndex,
    },
    SetUpTable {
        table: UpValueIndex,
        key: RCIndex,
        value: RCIndex,
    },
    SetList {
        base: RegisterIndex,
        count: VarCount,
    },
    Call {
        func: RegisterIndex,
        args: VarCount,
        returns: VarCount,
    },
    TailCall {
        func: RegisterIndex,
        args: VarCount,
    },
    Return {
        start: RegisterIndex,
        count: VarCount,
    },
    VarArgs {
        dest: RegisterIndex,
        count: VarCount,
    },
    Jump {
        offset: i16,
        close_upvalues: Opt254,
    },
    Test {
        value: RegisterIndex,
        is_true: bool,
    },
    TestSet {
        dest: RegisterIndex,
        value: RegisterIndex,
        is_true: bool,
    },
    Closure {
        dest: RegisterIndex,
        proto: PrototypeIndex,
    },
    NumericForPrep {
        base: RegisterIndex,
        jump: i16,
    },
    NumericForLoop {
        base: RegisterIndex,
        jump: i16,
    },
    GenericForCall {
        base: RegisterIndex,
        var_count: u8,
    },
    GenericForLoop {
        base: RegisterIndex,
        jump: i16,
    },
    Method {
        base: RegisterIndex,
        table: RegisterIndex,
        key: RCIndex,
    },
    Concat {
        dest: RegisterIndex,
        source: RegisterIndex,
        count: u8,
    },
    GetUpValue {
        dest: RegisterIndex,
        source: UpValueIndex,
    },
    SetUpValue {
        dest: UpValueIndex,
        source: RegisterIndex,
    },
    Length {
        dest: RegisterIndex,
        source: RegisterIndex,
    },
    Eq {
        skip_if: bool,
        left: RCIndex,
        right: RCIndex,
    },
    Less {
        skip_if: bool,
        left: RCIndex,
        right: RCIndex,
    },
    LessEq {
        skip_if: bool,
        left: RCIndex,
        right: RCIndex,
    },
    Not {
        dest: RegisterIndex,
        source: RegisterIndex,
    },
    Minus {
        dest: RegisterIndex,
        source: RegisterIndex,
    },
    Add {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    Sub {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    Mul {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    Div {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    IDiv {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    Mod {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    Pow {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    BitAnd {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    BitOr {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    BitXor {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    ShiftLeft {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    ShiftRight {
        dest: RegisterIndex,
        left: RCIndex,
        right: RCIndex,
    },
    BitNot {
        dest: RegisterIndex,
        source: RegisterIndex,
    },
}

Variants

Move

Fields

dest: RegisterIndex

source: RegisterIndex

LoadConstant

Fields

dest: RegisterIndex

constant: ConstantIndex16

LoadBool

Fields

dest: RegisterIndex

value: bool

skip_next: bool

LoadNil

Fields

dest: RegisterIndex

count: u8

NewTable

Fields

dest: RegisterIndex

array_size: u8

map_size: u8

GetTable

Fields

dest: RegisterIndex

table: RegisterIndex

key: RCIndex

SetTable

Fields

table: RegisterIndex

key: RCIndex

value: RCIndex

GetUpTable

Fields

dest: RegisterIndex

table: UpValueIndex

key: RCIndex

SetUpTable

Fields

table: UpValueIndex

key: RCIndex

value: RCIndex

SetList

Set elements of a table as a list.

Expects the table to be at the base index, and it expects a register for the last set table index at base + 1. The register at base + 1 must always be an integer.

On execution, it will set N values in the table at base + 1 + n, offset all of the indexes by the base + 1 startind index, and increment the starting index by however many values were set.

Fields

base: RegisterIndex

count: VarCount

Call

Call the given function with arguments placed after it, invalidates the function register and all registers above it. When the function returns, the results are placed starting where the function was located.

Fields

func: RegisterIndex

args: VarCount

returns: VarCount

TailCall

Effectively, call the given function with the arguments placed after it, and return the results of this function to the upper frame. Invalidates the entire current frame and replaces it with the called function.

Fields

func: RegisterIndex

args: VarCount

Return

Fields

start: RegisterIndex

count: VarCount

VarArgs

Places the contents of the “varargs” at the given register, expecting the given count. If the count is “variable”, then the top of the stack indicates the number of available arguments.

Fields

dest: RegisterIndex

count: VarCount

Jump

Fields

offset: i16

close_upvalues: Opt254

Test

Test the register as a boolean, if its boolean value matches is_true, skip the next instruction.

Fields

value: RegisterIndex

is_true: bool

TestSet

Test the value at the value register as a boolean, if its boolean value matches is_true, skip the next instruction, otherwise assign the given value (not converted to a boolean) to the destination register.

Fields

dest: RegisterIndex

value: RegisterIndex

is_true: bool

Closure

Fields

dest: RegisterIndex

proto: PrototypeIndex

NumericForPrep

Used to set up for a numeric for loop:

R(base) -= R(base + 2) pc += jump

Fields

base: RegisterIndex

jump: i16

NumericForLoop

Used to iterate a numeric for loop:

R(base) += R(base + 2) if R(base) <?= R(base + 1) then pc += jump R(base + 3) = R(base) end

The <?= operator here means “less than” if the step (aka R(base + 2)) is positive, and “greater than” if the step is negative

Fields

base: RegisterIndex

jump: i16

GenericForCall

Used to set up for a generic for loop:

R(base + 3), …, R(base + 2 + var_count) = R(base)(R(base + 1), R(base + 2))

Fields

base: RegisterIndex

var_count: u8

GenericForLoop

Used to iterate a generic for loop:

if R(base + 1) ~= nil then R(base) = R(base + 1) pc += jump end

Fields

base: RegisterIndex

jump: i16

Method

Used for calling methods on tables: R(base + 1) = R(table) R(base) = R(table)[RC(key)]

Fields

base: RegisterIndex

table: RegisterIndex

key: RCIndex

Concat

Concatenate the given arguments into a string

Fields

dest: RegisterIndex

source: RegisterIndex

count: u8

GetUpValue

Fields

dest: RegisterIndex

source: UpValueIndex

SetUpValue

Fields

dest: UpValueIndex

source: RegisterIndex

Length

Fields

dest: RegisterIndex

source: RegisterIndex

Eq

Fields

skip_if: bool

left: RCIndex

right: RCIndex

Less

Fields

skip_if: bool

left: RCIndex

right: RCIndex

LessEq

Fields

skip_if: bool

left: RCIndex

right: RCIndex

Not

Fields

dest: RegisterIndex

source: RegisterIndex

Minus

Fields

dest: RegisterIndex

source: RegisterIndex

Add

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

Sub

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

Mul

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

Div

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

IDiv

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

Mod

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

Pow

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

BitAnd

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

BitOr

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

BitXor

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

ShiftLeft

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

ShiftRight

Fields

dest: RegisterIndex

left: RCIndex

right: RCIndex

BitNot

Fields

dest: RegisterIndex

source: RegisterIndex

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Collect for Operation

where Operation: 'static,

fn needs_trace() -> bool

As an optimization, if this type can never hold a Gc pointer and trace is unnecessary to call, you may implement this method and return false. The default implementation returns true, signaling that Collect::trace must be called.

fn trace(&self, _cc: &Collection)

Must call Collect::trace on all held Gc pointers. If this type holds inner types that implement Collect, a valid implementation would simply call Collect::trace on all the held values to ensure this.

impl Debug for Operation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Copy for Operation