core/io.github.mataku.compose.highlight.core

Package-level declarations

Types

class IncrementalHighlighter(language: Language) : AutoCloseable

A stateful, single-threaded highlighter that reuses prior parse / capture / span work across successive update calls. Use this for editor-style scenarios where the source code changes incrementally; for one-shot or whole-file recomposition the existing highlight / rememberHighlightedString paths remain the right choice.

SyntaxTheme

@Immutable

data class SyntaxTheme(val baseStyle: SpanStyle = SpanStyle(), val background: Color? = null, val keyword: SpanStyle? = null, val function: SpanStyle? = null, val type: SpanStyle? = null, val string: SpanStyle? = null, val stringEscape: SpanStyle? = null, val number: SpanStyle? = null, val boolean: SpanStyle? = null, val comment: SpanStyle? = null, val constant: SpanStyle? = null, val property: SpanStyle? = null, val variable: SpanStyle? = null, val namespace: SpanStyle? = null, val operator: SpanStyle? = null, val punctuation: SpanStyle? = null, val extras: Map<String, SpanStyle> = emptyMap())

Maps tree-sitter highlight captures to SpanStyle values.

Utf8ByteIndex

class Utf8ByteIndex(text: String)

Properties

LocalSyntaxTheme

val LocalSyntaxTheme: ProvidableCompositionLocal<SyntaxTheme>

Composition local providing the active SyntaxTheme. Defaults to SyntaxTheme.DarkDefault. SyntaxHighlightedText reads from this local when its theme parameter is omitted.

Functions

highlight

fun highlight(code: String, language: Language, theme: SyntaxTheme): AnnotatedString

Returns an AnnotatedString of code with theme styles applied to tree-sitter capture spans defined by language. Each capture name is resolved through SyntaxTheme.resolve, which falls back along dotted prefixes (e.g. string.escape ->string) before yielding null.

rememberHighlightedString

@Composable

fun rememberHighlightedString(code: String, language: Language, theme: SyntaxTheme): AnnotatedString

Composable wrapper around highlight that caches the parsed tree-sitter Tree across theme-only changes. The first stage is keyed on (code, language) and re-parses only when one of those changes; the second stage applies theme to the cached tree. Native memory of the dropped tree is reclaimed by the JVM Cleaner registered in ktreesitter's Parser/Tree init blocks (no explicit disposal API exists).

rememberHighlightedStringAsync

@Composable

fun rememberHighlightedStringAsync(code: String, language: Language, theme: SyntaxTheme, context: CoroutineContext = Dispatchers.Default): State<AnnotatedString>

Async variant of rememberHighlightedString that runs highlight off the calling thread.