Module org.kink_lang.kink

Package org.kink_lang.kink

Class Vm

java.lang.Object

org.kink_lang.kink.Vm

public class Vm
extends Object

A Kink vm, or runtime.

Field Summary

Fields

Modifier and Type	Field	Description
final BinVal.Helper	bin	The helper for bin vals.
final BindingVal.Helper	binding	The helper for binding vals.
final BoolHelper	bool	The helper for bool vals.
final ComponentRegistry	component	The component registry.
final ExceptionVal.Helper	exception	The helper for exception vals.
final FunVal.Helper	fun	The helper of funs.
final GraphFacade	graph	The facade for the Execution Graph DSL.
final JavaVal.Helper	java	The helper for java vals.
final LocationVal.Helper	location	The helper for location vals.
final Val	nada	The nada val.
final NumVal.Helper	num	The helper for num vals.
final SharedVarsFactory	sharedVars	The factory of SharedVars.
final StrVal.Helper	str	The helper for str vals.
final SymRegistry	sym	The registry of syms.
final TraceVal.Helper	trace	The helper for trace vals.
final VarrefVal.Helper	varref	The helper for varref vals.
final VecVal.Helper	vec	The helper for vec vals.

Method Summary

Modifier and Type	Method	Description
final Val	newVal()	Returns a new val.
final Val	newVal(SharedVars sharedVars)	Returns a new val with the shared vars.
static Vm	newVm()	Returns a new vm.
<T> T	run(HostFunAction bootstrapAction, Function<? super Val,? extends T> onReturned, Function<? super ExceptionVal,? extends T> onRaised)	Runs a new execution stack which starts from the bootstrap action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

nada

public final Val nada

The nada val.

bool

public final BoolHelper bool

The helper for bool vals.

binding

public final BindingVal.Helper binding

The helper for binding vals.

num

public final NumVal.Helper num

The helper for num vals.

str

public final StrVal.Helper str

The helper for str vals.

bin

public final BinVal.Helper bin

The helper for bin vals.

fun

public final FunVal.Helper fun

The helper of funs.

varref

public final VarrefVal.Helper varref

The helper for varref vals.

exception

public final ExceptionVal.Helper exception

The helper for exception vals.

vec

public final VecVal.Helper vec

The helper for vec vals.

trace

public final TraceVal.Helper trace

The helper for trace vals.

location

public final LocationVal.Helper location

The helper for location vals.

java

public final JavaVal.Helper java

The helper for java vals.

sym

public final SymRegistry sym

The registry of syms.

graph

public final GraphFacade graph

The facade for the Execution Graph DSL.

sharedVars

public final SharedVarsFactory sharedVars

The factory of SharedVars.

component

public final ComponentRegistry component

The component registry.

Method Details

newVm

public static Vm newVm()

Returns a new vm.

Returns:

a new vm.

newVal

public final Val newVal()

Returns a new val.

Returns:

a new val.

newVal

public final Val newVal(SharedVars sharedVars)

Returns a new val with the shared vars.

Parameters:

sharedVars - shared vars as the initial variable mapping.

Returns:

a new val.

run

public <T> T run(HostFunAction bootstrapAction,
 Function<? super Val,? extends T> onReturned,
 Function<? super ExceptionVal,? extends T> onRaised)

Runs a new execution stack which starts from the bootstrap action.

The execution starts from bootstrapAction.

If the execution succeeds with a result, the method invokes onReturned with the result val. If the execution fails, the method invokes onRaised with the exception.

Example:

 FunVal fun = ...;
 boolean isSuccess = vm.run(
      c -> c.call(fun).args(x, y),
      result -> { System.out.printf("OK!: %s%n", result); return true; },
      exc -> { System.out.printf("Bad: %s", exc); return false; }
 );
 

Type Parameters:

T - the result type of onReturned and onRaised.

Parameters:

bootstrapAction - the action which is called to start the execution.

onReturned - called when the execution succeeds with a result.

onRaised - called when the execution fails with an exception.

Returns:

the result of onReturned or onRaised.