kitejs/io.github.yuroyami.kitejs/Context

Context

open class Context : AutoCloseable

The state one run of the engine carries: the language version, the error reporter, the feature flags, and the call stack bookkeeping the interpreter needs.

Upstream keeps the current context in a ThreadLocal, one per thread. This port is single-thread confined (D-3), so there is exactly one slot. Enter a context before running anything and exit it afterwards, or use ContextFactory.call, which does both.

Gone from upstream: class shutters, wrap factories, security controllers, class loaders, the debugger hooks and the E4X and LiveConnect surfaces. None of them have a meaning off the JVM.

Constructors

constructor()

Types

object Companion

fun interface Runnable

A unit of deferred work, run by processMicrotasks.

Properties

var clock: () -> Double

Where Date.now() and new Date() get the time, as epoch milliseconds. Defaults to the system clock; a test pins it so results do not depend on when the test runs.

var errorReporter: ErrorReporter

Where warnings and errors go. Defaults to a reporter that throws on error.

val factory: ContextFactory

implementationVersion

val implementationVersion: String

The version of this engine.

instructionObserverThreshold

val instructionObserverThreshold: Int

isGenerateObserverCount

open val isGenerateObserverCount: Boolean

isGeneratingDebug

val isGeneratingDebug: Boolean

isGeneratingDebugChanged

val isGeneratingDebugChanged: Boolean

isGeneratingSource

val isGeneratingSource: Boolean

isInterpretedMode

val isInterpretedMode: Boolean

Always true: there is no bytecode compiler in this port (D-15).

var isSealed: Boolean

val isStrictMode: Boolean

Whether the code running right now is in strict mode.

languageVersion

open var languageVersion: Int

The language version this context evaluates at. Changing it affects what gets compiled from then on. New code should use VERSION_ES6 or VERSION_ECMASCRIPT.

maximumInterpreterStackDepth

var maximumInterpreterStackDepth: Int

How deep the interpreter's call frames may go before it gives up.

var timeZone: TimeZone

The zone Date reads for local time. Defaults to the system's, and a test or an embedder can set it to anything. This is the only place the engine asks the platform about time zones; every other date calculation is its own arithmetic.

unhandledPromiseTracker

val unhandledPromiseTracker: UnhandledRejectionTracker

Where rejected promises with nothing to catch them are collected. Nothing is collected until trackUnhandledPromiseRejections turns it on, because what to do about them is the embedder's decision.

Functions

addActivationName

fun addActivationName(name: String)

open override fun close()

compileFunction

fun compileFunction(scope: Scriptable, source: String, sourceName: String?, lineno: Int, securityDomain: Any? = null): Function

Compiles source, which has to hold exactly one function, into a function object.

fun compileString(source: String, sourceName: String?, lineno: Int, securityDomain: Any? = null): Script

decompileFunction

fun decompileFunction(fun_: Function, indent: Int): String

decompileFunctionBody

fun decompileFunctionBody(fun_: Function, indent: Int): String

decompileScript

fun decompileScript(script: Script, indent: Int): String?

enqueueMicrotask

open fun enqueueMicrotask(task: Context.Runnable)

Queues work to run after the current top-level call finishes.

fun evaluateString(scope: Scriptable, source: String, sourceName: String?, lineno: Int, securityDomain: Any? = null): Any?

Compiles and runs source against scope, and returns what its last expression gave.

fun getElements(obj: Scriptable): Array<Any?>

The elements of an array-like object, with holes read as undefined.

fun getThreadLocal(key: Any): Any?

A value an embedder parks on the context under key.

open fun hasFeature(featureIndex: Int): Boolean

Whether an optional engine behaviour is on. The factory decides.

initSafeStandardObjects

fun initSafeStandardObjects(): ScriptableObject

fun initSafeStandardObjects(scope: ScriptableObject?): Scriptable

open fun initSafeStandardObjects(scope: ScriptableObject?, sealed: Boolean): ScriptableObject

initStandardObjects

fun initStandardObjects(): ScriptableObject

Makes a global scope with every standard object in it.

fun initStandardObjects(scope: ScriptableObject?): Scriptable

open fun initStandardObjects(scope: ScriptableObject?, sealed: Boolean): ScriptableObject

Fills scope, or a new TopLevel when null, with the standard objects.

isActivationNeeded

fun isActivationNeeded(name: String): Boolean

open fun newArray(scope: Scriptable, elements: Array<Any?>): Scriptable

open fun newArray(scope: Scriptable, length: Int): Scriptable

open fun newObject(scope: Scriptable): Scriptable

open fun newObject(scope: Scriptable, constructorName: String): Scriptable

open fun newObject(scope: Scriptable, constructorName: String, args: Array<Any?>): Scriptable

processMicrotasks

open fun processMicrotasks()

Runs the queued work, including anything it queues in turn, until the queue is empty.

fun putThreadLocal(key: Any, value: Any?)

removeActivationName

fun removeActivationName(name: String)

removeThreadLocal

fun removeThreadLocal(key: Any)

fun seal(sealKey: Any?)

Freezes every setting. With a non-null sealKey the same key unseals it again.

setErrorReporter

fun setErrorReporter(reporter: ErrorReporter): ErrorReporter

Sets the reporter and returns the old one, the way upstream's setter does.

setGenerateObserverCount

open fun setGenerateObserverCount(generateObserverCount: Boolean)

setGeneratingDebug

fun setGeneratingDebug(generatingDebug: Boolean)

setGeneratingSource

fun setGeneratingSource(generatingSource: Boolean)

setInstructionObserverThreshold

fun setInstructionObserverThreshold(threshold: Int)

How many instructions the interpreter runs between calls to ContextFactory.observeInstructionCount. Zero turns the observer off.

setInterpretedMode

fun setInterpretedMode(interpretedMode: Boolean)

stringIsCompilableUnit

fun stringIsCompilableUnit(source: String): Boolean

Whether source is a complete statement, or needs more lines before it could parse.

trackUnhandledPromiseRejections

fun trackUnhandledPromiseRejections(track: Boolean)

fun unseal(sealKey: Any)