engine/elide.runtime.plugins/AbstractLanguagePlugin

AbstractLanguagePlugin

@DelicateElideApi

abstract class AbstractLanguagePlugin<C : Any, I : Any> : EnginePlugin<C, I> , GuestLanguage

Abstract base class for language plugins.

Constructors

constructor()

Types

LanguagePluginManifest

@Serializable

data class LanguagePluginManifest(val engine: String, val language: String, val bundles: List<AbstractLanguagePlugin.LanguagePluginManifest.EmbeddedResource> = emptyList(), val scripts: List<AbstractLanguagePlugin.LanguagePluginManifest.EmbeddedResource> = emptyList(), val resources: Map<String, List<String>> = emptyMap(), val root: String? = null)

Provides information about resources embedded into the runtime, used by language plugins.

PreinitScript

@JvmRecord

data class PreinitScript(val name: String, val source: Source, val entry: Value? = null) : Record

Pre-initialization script built by initializePreambleScripts, which returns a suite of sources which are initialized at build time; these scripts should be passed verbatim to executePreambleScripts at runtime.

Properties

key

abstract val key: EnginePlugin.Key<I>

Identifies the plugin's instances, so they can be retrieved after being applied to the engine, avoiding the need for global references.

languageId

abstract val languageId: String

A unique string representing this language.

Functions

install

abstract fun install(scope: EnginePlugin.InstallationScope, configuration: C.() -> Unit): I

Install this plugin into the provided scope, using the configuration DSL block to adjust settings. This method is called from PluginRegistry.install to obtain a plugin Instance that will be added to the registry.