Struct Module

pub struct Module {
    pub source: Source,
    pub path: Option<PathBuf>,
    pub tokens: Vec<Token>,
    pub ast: Ast,
    pub functions: Vec<StoredFunction>,
    pub exports: Vec<(String, ExportType)>,
    pub scopes: Vec<HashMap<String, Value>>,
    pub structs: Vec<StoredStruct>,
    pub traits: Vec<TraitDef>,
    pub consts: Vec<StoredConst>,
    pub id: String,
}

Fields

source: Source

path: Option<PathBuf>

tokens: Vec<Token>

ast: Ast

functions: Vec<StoredFunction>

exports: Vec<(String, ExportType)>

scopes: Vec<HashMap<String, Value>>

structs: Vec<StoredStruct>

traits: Vec<TraitDef>

consts: Vec<StoredConst>

id: String

Implementations

impl Module

pub fn interpret_access( &mut self, access: AccessExpr, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Interpret an access expression.

Arguments

• access - AccessExpr expression to interpret.
• ctx - The context in which to interpret the access expression.
• vm - The virtual machine to use.

Returns

The result of the access expression.

pub fn access_field( &mut self, value: Value, expr: &Expr, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Access a field of a value.

Arguments

• value - The Value to access the field of.
• expr - The Expr representing the field to access.
• ctx - The context in which to access the field.

Returns

The value of the field.

impl Module

pub fn interpret_then_else( &mut self, then_else: ThenElse, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Interpret a then-else expression.

Arguments

• then_else - ThenElse expression to interpret.
• ctx - The context in which to interpret the then-else expression.
• vm - The virtual machine to use.

Returns

The result of the then-else expression.

pub fn interpret_if( &mut self, if_stmt: If, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Interpret an if statement.

Arguments

• if_stmt - If - The if statement to interpret.
• ctx - Context - The context in which to interpret the statement.

impl Module

pub fn interpret_try( &mut self, try_stmt: Try, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Interpret TryCatch expression.

Arguments

• try_catch - TryCatch expression to interpret.
• ctx - The context in which to interpret the TryCatch expression.

Returns

The result of the TryCatch expression.

pub fn interpret_throw( &mut self, throw: Throw, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Interpret a throw statement.

Arguments

• throw_stmt - The throw statement to interpret.
• ctx - The context in which to interpret the statement.

Returns

The result of the throw statement.

impl Module

pub fn interpret_expr( &mut self, expr: &Expr, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Interpret an expression.

Result of the expression is pushed onto the stack.

Arguments

• expr - Expr to interpret.
• ctx - The context in which to interpret the expression.

Returns

The result of the expression.

pub fn interpret_unary( &mut self, u: Unary, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Interpret a unary expression.

Arguments

• unary - Unary expression to interpret.
• ctx - The context in which to interpret the unary expression.
• vm - The virtual machine to use.

Returns

The result of the unary expression.

pub fn interpret_vec( &mut self, vec: VecExpr, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Interpret a vector expression.

Arguments

• vec - VecExpr to interpret.
• ctx - The context in which to interpret the vector expression.

Returns

The result of the vector expression.

pub fn interpret_binary( &mut self, binary_expr: Binary, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Interpret a binary expression.

Arguments

• binary_expr - Binary expression to interpret.
• ctx - The context in which to interpret the binary expression.

Returns

The result of the binary expression.

pub fn interpret_spread( &mut self, s: Spread, ctx: &mut Context, vm: &mut VM, values: &mut Vec<Value>, ) -> Result<()>

Interpret a spread expression.

This function requires vec of values to push to.

Arguments

• expr - Expr to interpret.
• ctx - The context in which to interpret the expression.
• values - The vec of values to push to.

Returns

The result of the expression.

pub fn interpret_possible_spread( &mut self, exprs: Vec<Expr>, ctx: &mut Context, vm: &mut VM, ) -> Result<Vec<Value>>

Helper function to interpret possible spread expressions.

Arguments

• exprs - The expressions to interpret.
• ctx - The context in which to interpret the expressions.
• vm - The virtual machine to use.

pub fn interpret_assignment( &mut self, assign: Assign, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Interpret an assignment expression.

Arguments

• assign - Assign expression to interpret.
• ctx - The context in which to interpret the assignment expression.

Returns

The result of the assignment expression.

impl Module

pub fn execute_native_function( &mut self, native: NativeFunction, args: Vec<Value>, vm: &mut VM, ) -> Result<()>

Executes a native function with the provided arguments.

pub fn execute_user_defined_function( &mut self, function: Fn, def_module: &mut Module, args: Vec<Value>, ctx: &mut Context, vm: &mut VM, call: &CallExpr, ) -> Result<()>

Executes a user-defined function with the provided arguments.

pub fn interpret_call( &mut self, call: &CallExpr, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Interpret a call expression.

Arguments

• call - CallExpr to interpret.
• ctx - The context in which to interpret the call.

Returns

The result of the call.

impl Module

pub fn interpret_stmt( &mut self, stmt: Stmt, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Interpret statement from the module.

Arguments

• stmt - Stmt - The statement to interpret.
• ctx - Context - The context in which to interpret the statement.

pub fn interpret_let( &mut self, l: Let, vm: &mut VM, ctx: &mut Context, ) -> Result<()>

Interpret a let statement.

Arguments

• let_stmt - Let - The let statement to interpret.
• vm - VM - The virtual machine to use for interpretation.
• ctx - Context - The context in which to interpret the statement.

pub fn handle_loop_result(&mut self, result: Result<()>) -> Result<()>

Handle the result of a loop statement.

RoanError::LoopBreak and RoanError::LoopContinue are handled if they are inside a loop otherwise they are returned as an error.

Arguments

• result - [Result<()>] - The result to handle.

pub fn interpret_loop( &mut self, loop_stmt: Loop, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Interpret a loop statement.

Arguments

• loop_stmt - Loop - The loop to interpret.
• ctx - Context - The context in which to interpret the loop.

pub fn interpret_while( &mut self, while_stmt: While, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Interpret a while loop.

Arguments

• while_stmt - While - The while loop to interpret.
• ctx - Context - The context in which to interpret the while loop.

pub fn interpret_function( &mut self, function: Fn, ctx: &mut Context, ) -> Result<()>

Interpret a function declaration.

Arguments

• function - Fn - The function to interpret.
• ctx - Context - The context in which to interpret the function.

pub fn interpret_use( &mut self, u: Use, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Interpret an use statement.

Arguments

• use_stmt - Use - The use statement to interpret.
• ctx - Context - The context in which to interpret the statement.

pub fn execute_block( &mut self, block: Block, ctx: &mut Context, vm: &mut VM, ) -> Result<()>

Execute a block of statements within a new scope.

Arguments

• block - Block - The block of statements to execute.

impl Module

pub fn interpret_struct_impl( &mut self, impl_stmt: StructImpl, ctx: &mut Context, ) -> Result<()>

Interpret a struct implementation.

Arguments

• impl_stmt - StructImpl - The struct implementation to interpret.

pub fn interpret_trait_impl( &mut self, impl_stmt: TraitImpl, ctx: &mut Context, ) -> Result<()>

Interpret a trait implementation.

Arguments

• impl_stmt - TraitImpl - The trait implementation to interpret.

pub fn get_trait(&self, name: &str, span: TextSpan) -> Result<TraitDef>

pub fn get_struct(&self, name: &str, span: TextSpan) -> Result<StoredStruct>

pub fn interpret_struct( &mut self, struct_stmt: Struct, ctx: &mut Context, ) -> Result<()>

Interpret a struct definition.

Arguments

• struct_def - Struct - The struct definition to interpret.
• ctx - Context - The context in which to interpret the struct definition.

Returns

The result of interpreting the struct definition.

pub fn interpret_trait( &mut self, trait_stmt: TraitDef, ctx: &mut Context, ) -> Result<()>

Interpret trait definition.

Arguments

• trait_def - TraitDef - The trait definition to interpret.
• ctx - Context - The context in which to interpret the trait definition.

Returns

The result of interpreting the trait definition.

pub fn interpret_struct_constructor( &mut self, constructor: StructConstructor, ctx: &mut Context, vm: &mut VM, ) -> Result<Value>

Interpret a struct constructor expression.

Arguments

• constructor - StructConstructor expression to interpret.
• ctx - The context in which to interpret the struct constructor expression.
• vm - The virtual machine to use.

Returns

The result of the struct constructor expression.

impl Module

pub fn new(source: Source) -> Self

Creates a new Module from the specified Source.

Parameters

• source - The source of the module.

Returns

An Arc<Mutex<Self>> containing the new Module.

pub fn id(&self) -> String

Get module id

pub fn path(&self) -> Option<PathBuf>

Returns the path of the module.

pub fn source(&self) -> &Source

Returns the source of the module.

pub fn tokens(&self) -> &Vec<Token>

Returns tokens of the module.

pub fn parse(&mut self) -> Result<()>

Parses the module.

First, the module is lexed into tokens. Then, the tokens are parsed into an AST.

pub fn interpret(&mut self, ctx: &mut Context, vm: &mut VM) -> Result<()>

pub fn enter_scope(&mut self)

Enter a new scope by pushing a new HashMap onto the scopes stack.

pub fn exit_scope(&mut self)

Exit the current scope by popping the top HashMap from the scopes stack.

pub fn declare_variable(&mut self, name: String, val: Value)

Declare a new variable in the current (innermost) scope.

pub fn set_variable(&mut self, name: &str, val: Value) -> Result<()>

Set an existing variable’s value in the nearest enclosing scope.

pub fn find_variable(&self, name: &str) -> Option<&Value>

Finds a variable by name, searching from the innermost scope outward.

pub fn find_const(&self, name: &str) -> Option<&StoredConst>

Finds a constant by name.

pub fn name(&self) -> String

pub fn extract_variable_name(expr: &Expr) -> Option<String>

pub fn find_function(&self, name: &str) -> Option<&StoredFunction>

Finds a function by name.

pub fn update_variable( &mut self, name: &str, val: Value, func: fn(_: Value, _: Value) -> Value, ) -> Result<()>

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.