text/org.k3lp.lib.text

Package-level declarations

Provides the baseline implementation for keyboard3 markers, marker-aware character strings, descriptors, and parsing facilities.

Types

EscapedCodePointNotAllowed

@WillRequireMigrationToRichErrors

data object EscapedCodePointNotAllowed : K3StringErrorsUnion

K3Descriptor

@Serializable(with = K3Descriptor.Serializer::class)

class K3Descriptor(val namespace: String, val type: String, val name: String) : K3StringOrDescriptor

Describes something by a qualified name. Its usage is to distinguish "normal" strings from special actions or references.

K3ListOfK3StringOrError

@WillRequireMigrationToRichErrors

sealed interface K3ListOfK3StringOrError

K3Marker

class K3Marker

Describes a marker by both unique ID and name. In keyboard3 files, markers are defined using the \m{…markerName} syntax.

K3MarkerPool

interface K3MarkerPool

A marker pool is a mapping between unique numeric ids and marker names. This is required for efficient runtime storage and comparison of in-band markers. See the discussion of marker ids in K3Marker.

K3MutableMarkerPool

interface K3MutableMarkerPool : K3MarkerPool

A mutable marker pool that allocates and maintains the mapping between unique ids and marker names.

K3String

class K3String : K3StringOrDescriptor, K3StringOrError, Iterable<K3StringAtom>

The K3String class represents marker-aware character strings for use in Keyboard3 models and runtimes.

K3StringAtom

@JvmInline

value class K3StringAtom(val packedValue: Int)

K3StringBuilder

class K3StringBuilder

A mutable sequence of characters and markers. Allows to efficiently build K3String objects.

K3StringErrorsUnion

@WillRequireMigrationToRichErrors

sealed interface K3StringErrorsUnion : K3StringOrError, K3ListOfK3StringOrError

K3StringOrDescriptor

sealed interface K3StringOrDescriptor

Union interface which allows a property to either be K3String or K3Descriptor.

K3StringOrError

@WillRequireMigrationToRichErrors

sealed interface K3StringOrError

MarkerNotAllowed

@WillRequireMigrationToRichErrors

data object MarkerNotAllowed : K3StringErrorsUnion

NoSuchSetVar

@WillRequireMigrationToRichErrors

data class NoSuchSetVar(val varId: K3VariableId) : K3StringErrorsUnion

NoSuchStringVar

@WillRequireMigrationToRichErrors

data class NoSuchStringVar(val varId: K3VariableId) : K3StringErrorsUnion

SetVarNotAllowed

@WillRequireMigrationToRichErrors

data object SetVarNotAllowed : K3StringErrorsUnion

StringVarNotAllowed

@WillRequireMigrationToRichErrors

data object StringVarNotAllowed : K3StringErrorsUnion

SyntaxError

@WillRequireMigrationToRichErrors

data class SyntaxError(val hint: String) : K3StringErrorsUnion

WillRequireMigrationToRichErrors

@RequiresOptIn

annotation class WillRequireMigrationToRichErrors

This annotation marks all API affected by a required future migration to Kotlin rich errors.

Functions

asK3String

fun CharSequence.asK3String(): K3String

Returns this String as a K3String.

buildK3String

inline fun buildK3String(builderAction: K3StringBuilder.() -> Unit): K3String

Builds new K3String by populating a newly created K3StringBuilder using provided builderAction and then converting it to K3String.

emptyK3MarkerPool

fun emptyK3MarkerPool(): K3MarkerPool

Returns an immutable and empty marker pool.

isNormalized

fun String.isNormalized(form: NormalizationForm): Boolean

Checks if this string is normalized.

fun K3String.isNormalized(form: NormalizationForm): Boolean

Checks if this K3String is normalized in a marker-aware-manner.

mutableK3MarkerPoolOf

fun mutableK3MarkerPoolOf(): K3MutableMarkerPool

Returns a new instance of a mutable marker pool.

normalize

fun String.normalize(form: NormalizationForm): String

Normalizes this string according to UAX#15.

fun K3String.normalize(form: NormalizationForm): K3String

Normalizes this K3String in a marker-aware manner, using the marker algorithm from Unicode TR35.

toK3String

@WillRequireMigrationToRichErrors

context(variableResolver: K3VariableResolver, markerPool: K3MutableMarkerPool)
fun String.toK3String(allowEscapedCodePoints: Boolean = true, allowEscapedMarkers: Boolean = true, allowStringVarRefs: Boolean = true): K3StringOrError

Parses this string to a K3String, and interprets or disallows escaped codepoints, markers, and string variable references.

toSetOfK3String

@WillRequireMigrationToRichErrors

context(variableResolver: K3VariableResolver, markerPool: K3MutableMarkerPool)
fun String.toSetOfK3String(): K3ListOfK3StringOrError

Parses this string to a set of K3String objects.