quarkdown-core/com.quarkdown.core.util

Package-level declarations

Types

IOUtils

object IOUtils

Utility methods for file-based operations.

StringCase

sealed interface StringCase

A general purpose strategy to transform a string to a specific case type.

Functions

case

fun String.case(case: StringCase): String

Transforms this string to a specific case.

filterNotNullEntries

fun <A, B> Sequence<Pair<A?, B?>>.filterNotNullEntries(): Sequence<Pair<A, B>>

filterNotNullValues

fun <A, B> Sequence<Pair<A, B?>>.filterNotNullValues(): Sequence<Pair<A, B>>

flattenedChildren

fun NestableNode.flattenedChildren(): Sequence<Node>

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

indent

fun CharSequence.indent(indent: String): String

Indents each line of this string by indent.

iterator

fun <T> Sequence<T>.iterator(consumeAmount: Int): Iterator<T>

nextOrNull

fun <T> Iterator<T>.nextOrNull(): T?

normalizeLineSeparators

fun CharSequence.normalizeLineSeparators(): CharSequence

removeOptionalPrefix

fun String.removeOptionalPrefix(prefix: String, ignoreCase: Boolean = false): Pair<String, Boolean>

replace

fun StringBuilder.replace(oldValue: String, newValue: String): StringBuilder

An optimized way to replace all occurrences of oldValue with newValue in a StringBuilder.

sanitizeFileName

fun String.sanitizeFileName(replacement: String): String

stripRichContent

fun InlineContent.stripRichContent(renderer: NodeVisitor<CharSequence>? = null): InlineContent

Strips rich content from this inline content and returns a new inline content with only one com.quarkdown.core.ast.base.inline.Text child, which contains the plain text representation of this inline content.

takeUntilLastOccurrence

fun String.takeUntilLastOccurrence(string: String): String

toPlainText

fun InlineContent.toPlainText(renderer: NodeVisitor<CharSequence>? = null): String

Converts processed InlineContent to its plain text representation. For example, the Markdown input foo **bar baz** has foo bar baz as its plain text.

toURLOrNull

fun String.toURLOrNull(): URL?

trimDelimiters

fun String.trimDelimiters(): String