Struct brane_ast::state::TableState

pub struct TableState {
    pub funcs: Vec<FunctionState>,
    pub tasks: Vec<TaskState>,
    pub classes: Vec<ClassState>,
    pub vars: Vec<VarState>,
    pub results: HashMap<String, String>,
}

Defines a ‘TableState’, which is the CompileState’s notion of a symbol table.

Fields

funcs: Vec<FunctionState>

The functions that are kept for next compilation junks

tasks: Vec<TaskState>

The tasks that are kept for next compilation junks

classes: Vec<ClassState>

The functions that are kept for next compilation junks

vars: Vec<VarState>

The functions that are kept for next compilation junks

results: HashMap<String, String>

The list of results introduced in this workflow.

Implementations

impl TableState

pub fn new() -> Self

Constructor for the TableState which initializes it with the builtin’s only.

We assume this is a toplevel table, so we assume no functions, tasks, classes or variables have been defined that this table needs to be aware of.

Returns

A new instance of the TableState.

pub fn empty() -> Self

Constructor for the TableState that doesn’t even initialize it to builtins.

Returns

A new, completely empty instance of the TableState.

pub fn none() -> Self

Constructor for the TableState that initializes it to not really a valid state (but kinda).

This is useful if you just need a placeholder for a table but know that the function body in question is never executed anyway (e.g.., builtins or external functions).

Returns

A new TableState instance that will keep the compiler happy but will probably result into runtime crashes once used (pay attention to overflows).

pub fn inject(&self, st: &mut RefMut<'_, SymbolTable>)

Injects the TableState into the given SymbolTable. The entries will already have indices properly resolved.

Only global definitions are injected. Any nested ones (except for class stuff) is irrelevant due to them never being accessed in future workflow snippets.

Arguments

• st: The (mutable) borrow to the symbol table where we will inject everything.

Returns

Nothing, but does alter the given symbol table to insert everything.

pub fn func(&self, id: usize) -> &FunctionState

Returns the function with the given index, if any.

Arguments

• id: The ID/index of the function to get the compile state of.

Returns

A reference to the corresponding FunctionState.

Panics

This function may panic if id is out-of-bounds.

pub fn task(&self, id: usize) -> &TaskState

Returns the task with the given index, if any.

Arguments

• id: The ID/index of the task to get the compile state of.

Returns

A reference to the corresponding TaskState.

Panics

This function may panic if id is out-of-bounds.

pub fn class(&self, id: usize) -> &ClassState

Returns the class with the given index, if any.

Arguments

• id: The ID/index of the class to get the compile state of.

Returns

A reference to the corresponding ClassState.

Panics

This function may panic if id is out-of-bounds.

pub fn var(&self, id: usize) -> &VarState

Returns the variable with the given index, if any.

Arguments

• id: The ID/index of the variable to get the compile state of.

Returns

A reference to the corresponding VarState.

Panics

This function may panic if id is out-of-bounds.

pub fn n_funcs(&self) -> usize

Returns the offset for the functions.

pub fn n_tasks(&self) -> usize

Returns the offset for the tasks.

pub fn n_classes(&self) -> usize

Returns the offset for the classes.

pub fn n_vars(&self) -> usize

Returns the offset for the variables.

Trait Implementations

impl Clone for TableState

fn clone(&self) -> TableState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableState

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

Formats the value using the given formatter.

impl Default for TableState

fn default() -> Self

Returns the “default value” for a type.

impl From<&TableState> for SymTable

fn from(value: &TableState) -> Self

Converts to this type from the input type.

impl From<TableState> for SymTable

fn from(value: TableState) -> Self

Converts to this type from the input type.