core/org.k3lp.runtime/K3KeystrokeEngine

K3KeystrokeEngine

open class K3KeystrokeEngine(val model: K3Model, val multiTapTimeout: Duration = 200.milliseconds, val timeSource: TimeSource = TimeSource.Monotonic)(source)

The core keystroke engine for the k3lp library. This engine is responsible for handling raw key inputs, evaluating multi-tap behaviors, and mapping keystrokes to their respective outputs/actions based on the provided model.

New implementation specific actions can be added with the getActionForMarker function.

val customAction = getActionForMarker("namespace:customAction")

The namespace can be any valid alphanumerical custom string, e.g. example.

Constructors

K3KeystrokeEngine

constructor(model: K3Model, multiTapTimeout: Duration = 200.milliseconds, timeSource: TimeSource = TimeSource.Monotonic)

Creates a new instance of the K3 keystroke engine with the specified model and timing configurations.

Properties

inputContext

protected val inputContext: K3StringBuilder

The current inputContext.

model

val model: K3Model

The K3Model

multiTapTimeout

val multiTapTimeout: Duration

outputText

val outputText: StateFlow<String>

StateFlow of the current output text.

timeSource

val timeSource: TimeSource

Functions

descriptorOf

protected fun descriptorOf(qualifiedName: String): K3Descriptor?

Obtain the K3Descriptor for the given qualified name.

emit

fun emit(value: K3StringOrDescriptor): Boolean

Processes a given K3String or K3Descriptor. If the value is a string, this function behaves as if emitText was directly invoked. If the value is a descriptor, the namespaced descriptor processor (if any) will be invoked.

emitBackspace

fun emitBackspace(): Boolean

Performs a backspace action by first doing a backspace transform pass, followed by a simple transform pass.

emitDescriptor