core/org.k3lp.model

Package-level declarations

Provides the model classes, which represents a keyboard3 file in-memory, after parsing and compilation.

Types

Base interface for a model compilation result.

data class K3ImpliedImports(val variables: List<String> = emptyList(), val displays: List<String> = emptyList(), val flicks: List<String> = emptyList(), val forms: List<String> = emptyList(), val keys: List<String> = emptyList())

Configures implied imports.

Contract interface for resolving scoped import paths encountered during model compilation.

Generic compilation failed exception. The report list contains detailed errors and descriptions.

class K3Model(val conformsTo: CldrVersion, val xmlns: String?, val locales: List<String>, val version: String?, val info: K3Info, val settings: K3Settings?, val displays: K3Displays, val keys: K3Keys, val flicks: K3Flicks, val forms: K3Forms, val layersByForm: K3LayersByForm, val variables: K3Variables, val transforms: K3Transforms, val markerPool: K3MarkerPool)

A compiled and immutable keyboard3 model.

Base interface for all components in a compiled model.

suspend fun TextSourceFile.compileToModel(importResolver: K3ImportResolver = K3ImportResolver.Noop, impliedImports: K3ImpliedImports = K3ImpliedImports.None, markerPool: K3MutableMarkerPool = mutableK3MarkerPoolOf()): K3CompileResult