metis-lang/io.github.seggan.metis.runtime/State

State

class State(val parentState: State? = null)

Represents the state of a Metis virtual machine. This is the class that is used to run Metis code.

Constructors

State

constructor(parentState: State? = null)

Types

Companion

object Companion

Properties

breakpoints

val breakpoints: MutableList<Breakpoint>

The breakpoints of the state. Only used if debugMode is true.

currentDir

var currentDir: String

The current working directory of the state.

debugInfo

var debugInfo: DebugInfo?

The debug information of the state. Only set if debugMode is true.

debugMode

var debugMode: Boolean

True if the state is in debug mode.

fileSystem

var fileSystem: FileSystem

The FileSystem used by the state.

globals

val globals: Value.Table

The global variables of the state.

loaders

val loaders: MutableList<ModuleLoader>

localsOffset

val localsOffset: Int

The offset of the local variables of the current function in the stack.

parentState

val parentState: State? = null

recursionLimit

var recursionLimit: Int

The recursion limit of the state.

stack

val stack: ArrayDeque<Value>

The stack of the state.

stderr

var stderr: OutputStream

The standard error stream of the state.

stdin

var stdin: InputStream

The standard input stream of the state.

stdout

var stdout: OutputStream

The standard output stream of the state.

Functions

addNativeLibrary

fun addNativeLibrary(lib: NativeLibrary)

Adds a NativeLibrary to the state.

call

fun call(nargs: Int, selfProvided: Boolean = false, span: Span? = null)

Calls the top of the stack with nargs arguments.

index

fun index()

Performs an index operation on the stack.

fun is()

Performs a is operation on the top of the stack.

loadChunk

fun loadChunk(chunk: Chunk)

Loads a chunk into the state but does not call it.

loadCoreGlobals

fun loadCoreGlobals()

Loads all the core globals into the state, like print, io, etc.

loadStandardLibrary

fun loadStandardLibrary()

Loads the standard library into the state.

metaCall

fun metaCall(nargs: Int, metamethod: String, span: Span? = null)

Performs a metamethod call on the value nargs below the top of the stack.

newError

fun newError(type: String)

Creates a new MetisRuntimeException and pushes it to the stack.

not

fun not()

Performs a not operation on the top of the stack.

removeNativeLibrary

fun removeNativeLibrary(name: String)

Removes a NativeLibrary from the state.

runCode

fun runCode(source: CodeSource)

Loads the given CodeSource and runs it.

runTillComplete

fun runTillComplete()

Runs the state till it is finished.

set

fun set()

Performs a set operation on the stack.

step

fun step(): StepResult

Steps the state.

stringify

fun stringify(value: Value): String

Stringifies the given value according to its __str__ metamethod.

wrapToList

fun wrapToList(values: Int)

Wraps the top values values of the stack into a Value.List.

wrapToTable

fun wrapToTable(values: Int)

Wraps the top values values of the stack into a Value.Table.