text/org.k3lp.lib.text

Package-level declarations

Types

EscapedCodePointNotAllowed

@WillRequireMigrationToRichErrors

data object EscapedCodePointNotAllowed : K3StringErrorsUnion

class K3Descriptor : K3StringOrDescriptor

K3DescriptorProcessor

fun interface K3DescriptorProcessor<R>

K3ListOfK3StringOrError

@WillRequireMigrationToRichErrors

sealed interface K3ListOfK3StringOrError

interface K3MarkerPool

K3MutableMarkerPool

interface K3MutableMarkerPool : K3MarkerPool

class K3String : K3StringOrDescriptor, K3StringOrError, Iterable<K3StringAtom>

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

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

K3StringOrError

@WillRequireMigrationToRichErrors

sealed interface K3StringOrError

K3VariableResolver

interface K3VariableResolver

Base interface describing a variable resolver.

MarkerNotAllowed

@WillRequireMigrationToRichErrors

data object MarkerNotAllowed : K3StringErrorsUnion

@WillRequireMigrationToRichErrors

data class NoSuchSetVar(val varId: String) : K3StringErrorsUnion

NoSuchStringVar

@WillRequireMigrationToRichErrors

data class NoSuchStringVar(val varId: String) : K3StringErrorsUnion

SetVarNotAllowed

@WillRequireMigrationToRichErrors

data object SetVarNotAllowed : K3StringErrorsUnion

StringVarNotAllowed

@WillRequireMigrationToRichErrors

data object StringVarNotAllowed : K3StringErrorsUnion

@WillRequireMigrationToRichErrors

data class SyntaxError(val hint: String) : K3StringErrorsUnion

WillRequireMigrationToRichErrors

annotation class WillRequireMigrationToRichErrors

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

Functions

fun String.asK3String(): K3String

Returns this String as a K3String.

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

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

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.

@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.