Struct Interpreter

pub struct Interpreter<State> {
    pub state: State,
    /* private fields */
}

The core interpreter object. Takes in a custom defined state that can be modified by built-ins.

Fields

state: State

Custom state for each application. Allows users to register built-ins that modify this state.

Implementations

impl<State> Interpreter<State>

pub fn reset_program(&mut self)

Resets the program counter and clears the program and program debug locations but preserves RAM and stack.

impl<State> Interpreter<State>

pub fn format_code(code: &str, path: Option<PathBuf>) -> Result<String, Err>

Format a code file.

pub fn stringify_program(&self) -> String

Returns the program as a formatted string.

impl<State> Interpreter<State>

pub fn new(state: State) -> Self

Create a new interpreter. Pass in the initial custom state for the interpreter.

pub fn evaluate(&mut self, code: &str, path: Option<PathBuf>) -> Result<(), Err>

Evaluate a program.

pub fn get_name(&self, address: Address) -> String

Get the name of an address if present.

pub fn pop(&mut self) -> Result<StackValue, Err>

Pop a value from the stack.

pub fn pop_bool(&mut self) -> Result<bool, Err>

Pop a boolean from the stack.

pub fn pop_number(&mut self) -> Result<f32, Err>

Pop a number from the stack.

pub fn push_number(&mut self, number: f32)

Push a number onto the stack.

pub fn push_address(&mut self, address: Address)

Push an address onto the stack.

pub fn pop_address(&mut self) -> Result<Address, Err>

Pop an address from the stack.

pub fn push_string(&mut self, string: String)

Push a string onto the stack.

pub fn pop_string(&mut self) -> Result<String, Err>

Pop a string from the stack.

pub fn start_repl(&mut self) -> Result<(), Err>

Start a REPL.

pub fn register_builtin( &mut self, name: &str, stack_modification: &str, documentation: &str, example: &str, func: BuiltIn<State>, )

Register a built-in function to be used in the interpreter.

pub fn print_documentation(&self)

Print the documentation for all words.