Struct rant::runtime::VM

pub struct VM<'rant> { /* private fields */ }

The Rant Virtual Machine.

Implementations

impl<'rant> VM<'rant>

pub fn push_getter_intents(
    &mut self,
    path: &Rc<AccessPath>,
    override_print: bool,
    prefer_function: bool,
    fallback: Option<Rc<Sequence>>
)

pub fn call_func(
    &mut self,
    func: RantFunctionHandle,
    args: Vec<RantValue>,
    override_print: bool
) -> RuntimeResult<()>

Prepares a call to a function with the specified arguments.

pub fn tick_current_block(&mut self) -> RuntimeResult<()>

Checks for an active block and attempts to iterate it. If a valid element is returned, it is pushed onto the call stack.

pub fn pre_push_block(&mut self, block: &Rc<Block>) -> RuntimeResult<()>

Performs any necessary preparation (such as pushing weight intents) before pushing a block. If the block can be pushed immediately, it will be.

pub fn push_block(
    &mut self,
    block: &Block,
    weights: Option<Weights>
) -> RuntimeResult<()>

Consumes attributes and pushes a block onto the resolver stack.

pub fn get_var_value(
    &self,
    varname: &str,
    access: VarAccessMode,
    prefer_function: bool
) -> RuntimeResult<RantValue>

Gets the value of an existing variable.

pub fn def_var_value(
    &mut self,
    varname: &str,
    access: VarAccessMode,
    val: RantValue,
    is_const: bool
) -> RuntimeResult<()>

Defines a new variable in the current scope.

pub fn push_val(&mut self, val: RantValue) -> RuntimeResult<usize>

Pushes a value onto the value stack.

pub fn pop_val(&mut self) -> RuntimeResult<RantValue>

Removes and returns the topmost value from the value stack.

pub fn pop_frame(&mut self) -> RuntimeResult<StackFrame<Intent>>

Removes and returns the topmost frame from the call stack.

pub fn push_frame(
    &mut self,
    callee: Rc<Sequence>,
    has_scope: bool
) -> RuntimeResult<()>

Pushes a frame onto the call stack.

pub fn push_native_call_frame(
    &mut self,
    callee: Box<dyn FnOnce(&mut VM<'_>) -> RuntimeResult<()>>,
    flavor: StackFrameFlavor
) -> RuntimeResult<()>

Pushes an empty frame onto the call stack with a single RuntimeCall intent.

pub fn push_frame_flavored(
    &mut self,
    callee: Rc<Sequence>,
    flavor: StackFrameFlavor
) -> RuntimeResult<()>

Pushes a flavored frame onto the call stack.

pub fn interrupt_repeater(
    &mut self,
    break_val: Option<RantValue>,
    should_continue: bool
) -> RuntimeResult<()>

Interrupts execution of a repeater and either continues the next iteration or exits the block.

pub fn func_return(&mut self, ret_val: Option<RantValue>) -> RuntimeResult<()>

Returns from the currently running function.

pub fn cur_frame_mut(&mut self) -> &mut StackFrame<Intent>

Gets a mutable reference to the topmost frame on the call stack.

pub fn any_cur_frame_mut(&mut self) -> Option<&mut StackFrame<Intent>>

Safely attempts to get a mutable reference to the topmost frame on the call stack.

pub fn parent_frame_mut(
    &mut self,
    depth: usize
) -> Option<&mut StackFrame<Intent>>

Safely attempts to get a mutable reference to the frame depth frames below the top of the call stack.

pub fn parent_frame(&self, depth: usize) -> Option<&StackFrame<Intent>>

Safely attempts to get a reference to the frame depth frames below the top of the call stack.

pub fn cur_frame(&self) -> &StackFrame<Intent>

Gets a reference to the topmost frame on the call stack.

pub fn rng(&self) -> &RantRng

Gets a reference to the topmost RNG on the RNG stack.

pub fn rng_clone(&self) -> Rc<RantRng>

Gets a copy of the topmost RNG on the RNG stack.

pub fn push_rng(&mut self, rng: Rc<RantRng>)

Adds a new RNG to the top of the RNG stack.

pub fn pop_rng(&mut self) -> Option<Rc<RantRng>>

Removes the topmost RNG from the RNG stack and returns it.

pub fn context(&self) -> &Rant

Gets a reference to the Rant context that created the VM.

pub fn context_mut(&mut self) -> &mut Rant

Gets a mutable reference to the Rant context that created the VM.

pub fn resolver(&self) -> &Resolver

Gets a reference to the resolver associated with the VM.

pub fn resolver_mut(&mut self) -> &mut Resolver

Gets a mutable reference to the resolver associated with the VM.

pub fn program(&self) -> &RantProgram

Gets a reference to the program being executed by the VM.

pub fn push_unwind_state(&mut self, handler: Option<RantFunctionHandle>)

pub fn unwind(&mut self) -> Option<UnwindState>