engine/elide.runtime.core/PolyglotEngineConfiguration

PolyglotEngineConfiguration

abstract class PolyglotEngineConfiguration : PluginRegistry

This class acts as the root of the engine configuration DSL, allowing plugins to be installed and exposing general features such as enabling support for specific languages.

Instances of this class cannot be created manually; instead, they are provided by the PolyglotEngine method, which serves as entry point for the DSL.

Constructors

constructor()

Types

HostAccess

enum HostAccess : Enum<PolyglotEngineConfiguration.HostAccess>

Lists the access privileges that can be conceded to guest code over host resources, such as environment variables, or file system (IO).

Properties

hostAccess

var hostAccess: PolyglotEngineConfiguration.HostAccess

The access granted to guest code over host resources, such as environment variables and the file system.

hostPlatform

val hostPlatform: HostPlatform

Information about the platform hosting the runtime.

hostRuntime

abstract val hostRuntime: HostRuntime

Information about the runtime engine.

Functions

args

abstract fun args(args: Array<String>)

Set the main entrypoint arguments to expose to guest languages.

blockUntilReady

abstract fun blockUntilReady()

Block until this configuration has finished bootstrapping the GraalVM guest context; this will wait until all init tasks for all plugins have completed.

configure

abstract fun <C : Any, I : Any> configure(plugin: EnginePlugin<C, I>, configure: C.() -> Unit = { })

Lazily configure a plugin for use.

enableLanguage

abstract fun enableLanguage(language: GuestLanguage)

Enables support for the specified language on all contexts created by the engine.

getOrInstall

@DelicateElideApi

fun <C : Any, T : Any> PluginRegistry.~~getOrInstall~~(plugin: EnginePlugin<C, T>, configure: C.() -> Unit = { }): T

Returns the installed plugin instance from the registry, or throws IllegalStateException of no plugin instance is found.

install

abstract fun <C : Any, I : Any> ~~install~~(plugin: EnginePlugin<C, I>, configure: C.() -> Unit = { }): I

Install a plugin and configure it.

plugin

abstract fun <T> plugin(key: EnginePlugin.Key<T>): T?

Retrieve a plugin instance identified by the provided key from this registry. If no instance is registered for that key, null will be returned.

plugin

@DelicateElideApi

fun <T : Any> PluginRegistry.plugin(plugin: EnginePlugin<*, T>): T?

Returns the installed plugin instance from the registry, or null if this plugin is not installed.

registeredBundles

abstract fun registeredBundles(): List<URL>

Return the current list of resources which should be made available for this plug-in; the resulting list is a read-only copy.

requirePlugin

@DelicateElideApi

fun <T> PluginRegistry.requirePlugin(key: EnginePlugin.Key<T>): T

Returns the plugin instance associated with the given key, or throws IllegalStateException of no plugin instance is found.

@DelicateElideApi

fun <T : Any> PluginRegistry.requirePlugin(plugin: EnginePlugin<*, T>): T

Returns the installed plugin instance from the registry, or throws IllegalStateException of no plugin instance is found.