text/org.k3lp.lib.text.regex

Package-level declarations

Multiplatform marker-aware search&replace regex, to enable regex-based transform rules.

Types

K3RegexErrorsUnion

@WillRequireMigrationToRichErrors

sealed interface K3RegexErrorsUnion : K3SearchRegexOrError, K3SReplaceRegexOrError

K3ReplaceInstr

sealed interface K3ReplaceInstr

K3ReplaceRegex

class K3ReplaceRegex(val instrs: List<K3ReplaceInstr>) : K3SReplaceRegexOrError

Represents a K3SearchRegex, a subset of ECMA regex, with support for marker matching.

K3SearchInstr

sealed interface K3SearchInstr

K3SearchInstrGroup

sealed interface K3SearchInstrGroup : K3SearchInstr

K3SearchInstrQuantifier

@JvmInline

value class K3SearchInstrQuantifier

K3SearchRegex

class K3SearchRegex(val rootInstr: K3SearchInstr, val minAtomCount: Int, val maxAtomCount: Int) : K3SearchRegexOrError

Represents a K3SearchRegex, a subset of ECMA regex, with support for marker matching.

K3SearchRegexOrError

@WillRequireMigrationToRichErrors

sealed interface K3SearchRegexOrError

K3SearchResult

class K3SearchResult(matches: List<K3SearchResult.CapturedMatch?>)

A search result for a regex match.

K3SReplaceRegexOrError

@WillRequireMigrationToRichErrors

sealed interface K3SReplaceRegexOrError

NoSuchSetVar

@WillRequireMigrationToRichErrors

data class NoSuchSetVar(val varId: K3VariableId) : K3RegexErrorsUnion

NoSuchStringVar

@WillRequireMigrationToRichErrors

data class NoSuchStringVar(val varId: K3VariableId) : K3RegexErrorsUnion

NoSuchUSetVar

@WillRequireMigrationToRichErrors

data class NoSuchUSetVar(val varId: K3VariableId) : K3RegexErrorsUnion

RegexMustNotMatchEmpty

@WillRequireMigrationToRichErrors

data class RegexMustNotMatchEmpty(val string: String) : K3RegexErrorsUnion

SyntaxError

@WillRequireMigrationToRichErrors

data class SyntaxError(val hint: String) : K3RegexErrorsUnion

Functions

fun K3String.search(regex: K3SearchRegex): K3SearchResult?

Attempts to match given regex against this string.

toK3ReplaceRegex

@WillRequireMigrationToRichErrors

context(variableResolver: K3VariableResolver, markerPool: K3MutableMarkerPool)
fun String.toK3ReplaceRegex(): K3SReplaceRegexOrError

Parses given string to a replacement regex, or returns an error.

toK3SearchRegex

@WillRequireMigrationToRichErrors

context(variableResolver: K3VariableResolver, markerPool: K3MutableMarkerPool)
fun String.toK3SearchRegex(): K3SearchRegexOrError

Parses given string to a search regex, or returns an error.