engine/elide.runtime.core

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class DelicateElideApi

Marks an element as part of Elide's delicate core API, which is intended to be used by the runtime development team.

EngineLifecycle

@DelicateElideApi

interface EngineLifecycle

The lifecycle allows plugins to subscribe to events such as engine and context configuration.

EngineLifecycleEvent

@DelicateElideApi

sealed interface EngineLifecycleEvent<T>

Represents a type-safe event key that can be dispatched by EngineLifecycle implementations, and consumed by plugins. Each event indicates the type of the subject provided to consumers using a generic type parameter.

EnginePlugin

@DelicateElideApi

interface EnginePlugin<Config : Any, Instance : Any>

Engine plugins provide a generic way to extend a PolyglotEngine and its PolyglotContext instances using an intuitive configuration DSL:

GuestLanguage

@DelicateElideApi

interface GuestLanguage

Represents a language supported by a PolyglotContext, providing a key for identification of guest bindings and other contextual elements.

GuestLanguageEvaluator

@DelicateElideApi

interface GuestLanguageEvaluator

A GuestLanguage feature for evaluating Source code in a given PolyglotContext.

GuestLanguageParser

@DelicateElideApi

interface GuestLanguageParser

A GuestLanguage feature for parsing Source code in a given PolyglotContext, returning an executable PolyglotValue.

HostPlatform

@DelicateElideApi

data class HostPlatform(val os: HostPlatform.OperatingSystem, val arch: HostPlatform.Architecture)

Provides read-only information about the Host platform, which can be used by plugins to run platform-specific code.

HostRuntime

@DelicateElideApi

interface HostRuntime

Provides information about the runtime hosting the application.

PluginRegistry

@DelicateElideApi

interface PluginRegistry

The PluginRegistry interface defines the base contract for classes that allow installing and managing engine plugins.

PolyglotContext

@DelicateElideApi

interface PolyglotContext

The Polyglot Context is the core of the Elide runtime: it evaluates guest code in the embedded VM, returning the execution result. Context instances can be acquired from a PolyglotEngine.

PolyglotContextBuilder

@DelicateElideApi

typealias PolyglotContextBuilder = Context.Builder

A builder allowing configuration of PolyglotContext instances. Plugins can intercept builders to apply custom options using this class.

PolyglotContextElement

@DelicateElideApi

@JvmInline

value class PolyglotContextElement<T>(val key: String)

A type-safe key used to store and retrieve values in a PolyglotContext.

PolyglotEngine

@DelicateElideApi

interface PolyglotEngine

The Polyglot Engine is responsible for creating new PolyglotContext instances, as well as triggering events that allow plugins to extend the runtime.

PolyglotEngineBuilder

@DelicateElideApi

typealias PolyglotEngineBuilder = Engine.Builder

A builder allowing configuration of PolyglotEngine instances. Plugins can intercept builders to apply custom options using this class.

PolyglotEngineConfiguration

@DelicateElideApi

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.

PolyglotValue

typealias PolyglotValue = Value

A value managed by the polyglot engine. It is common for instances to be obtained after evaluating guest code in a PolyglotContext.

Version

@DelicateElideApi

data class Version(val major: Int, val minor: Int = 0, val patch: Int = 0) : Comparable<Version>

Represents a semantic version that can be compared with others or used to form a version range. Version objects are used to enable version-aware behavior in engine plugins.

Properties

isUnix

@DelicateElideApi

val HostPlatform.OperatingSystem.isUnix: Boolean

Whether this OS family is UNIX-based. Returns true for LINUX and DARWIN enum entries.

Functions

andHigher

@DelicateElideApi

fun Version.andHigher(): Version.Range

Returns a version range including this and every higher version.

andLower

@DelicateElideApi

fun Version.andLower(): Version.Range

Returns a version range including this and every lower version.

evaluate

@DelicateElideApi

fun PolyglotContext.evaluate(language: GuestLanguage, source: String, name: String? = null, internals: Boolean = false, interactive: Boolean = PolyglotDefaults.DEFAULT_INTERACTIVE, cached: Boolean = PolyglotDefaults.DEFAULT_CACHED, uri: URI? = null): PolyglotValue

Evaluate a fragment of source code in the specified language, returning the result of the execution. Depending on the configuration of the context, this method may fail if the language is not enabled in the underlying 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.

@DelicateElideApi

inline fun <R> HostRuntime.on(version: Version, block: () -> R): R?

Execute a block and return its result if this runtime's is running the provided version, otherwise return null. If this runtime's version can't be detected, null will be returned.

@DelicateElideApi

inline fun <R> HostRuntime.on(range: Version.Range, block: () -> R): R?

Execute a block and return its result if this runtime's version is in the provided range, otherwise return null. If this runtime's version can't be detected, null will be returned.

parse

@DelicateElideApi

fun PolyglotContext.parse(language: GuestLanguage, source: String, name: String? = null, internals: Boolean = false, interactive: Boolean = PolyglotDefaults.DEFAULT_INTERACTIVE, cached: Boolean = PolyglotDefaults.DEFAULT_CACHED, uri: URI? = null): PolyglotValue

Parse a fragment of source code in the specified language, returning the parsed value, which is typically executable. Depending on the configuration of the context, this method may fail if the language is not enabled in the underlying engine.

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.

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.