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

Package-level declarations

Types

Arity

data class Arity(val required: Int, val requiresSelf: Boolean = false, val isVarargs: Boolean = false)

The argument information for a CallableValue.

CallableValue

interface CallableValue : Value

A Value that can be called.

MetisRuntimeException

open class MetisRuntimeException(val type: String, actualMessage: String, companionData: Value.Table = Value.Table(), cause: Throwable? = null) : MetisException, Value

A runtime exception that can be thrown from Metis code.

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.

Value

interface Value

A value in the Metis runtime.

Functions

asObj

inline fun <T> Value.asObj(): T

If this is a Value.Native, returns the native object, otherwise throws an error.

booleanValue

fun Value.booleanValue(): Boolean

Converts this value to a kotlin.Boolean, or throws an error if it cannot be converted.

buildTable

inline fun buildTable(init: (MutableMap<String, Value>) -> Unit): Value.Table

Builds a Value.Table

bytesValue

fun Value.bytesValue(): ByteArray

Converts this value to a Value.Bytes, or throws an error if it cannot be converted.

convertTo

inline fun <T : Value> Value.convertTo(): T

Converts this value to a T, or throws an error if it cannot be converted.

doubleValue

fun Value.doubleValue(): Double

Converts this value to a Double, or throws an error if it cannot be converted.

get

operator fun MutableMap<Value, Value>.get(key: String): Value?

intValue

fun Value.intValue(): Int

Converts this value to a Int, or throws an error if it cannot be converted.

listValue

fun Value.listValue(): MutableList<Value>

Converts this value to a Value.List, or throws an error if it cannot be converted.

lookUp

fun Value.lookUp(key: Value): Value?

Look up a value in this value, possibly using the metatable.

lookUpHierarchy

fun Value.lookUpHierarchy(vararg keys: String): Value?

Look up a successive sequence of strings in this value.

metisValue

fun Boolean.metisValue(): Value.Boolean

Converts a kotlin.Boolean to a Value.Boolean

fun ByteArray.metisValue(): Value.Bytes

Converts a ByteArray to a Value.Bytes

fun Double.metisValue(): Value.Number

Converts a Double to a Value.Number

fun Int.metisValue(): Value.Number

Converts an Int to a Value.Number

fun String.metisValue(): Value.String

Converts a String to a Value.String

fun Collection<Value>.metisValue(): Value.List

Converts a Collection of Values to a Value.List

orNull

fun Value?.orNull(): Value

If this value is null, return Value.Null, otherwise return this value.

set

fun Value.set(key: Value, value: Value): Boolean

Sets a value in this value, possibly using the metatable.

operator fun MutableMap<Value, Value>.set(key: String, value: Value)

setOrError

fun Value.setOrError(key: Value, value: Value)

Sets a value in this value, or throws an error if it cannot be set.

stringValue

fun Value.stringValue(): String

Converts this value to a String, or throws an error if it cannot be converted.

tableValue

fun Value.tableValue(): MutableMap<Value, Value>

Converts this value to a Value.Table, or throws an error if it cannot be converted.

typeToName

fun typeToName(clazz: KClass<out Value>): String

Converts a Value's class to an end user-friendly name.