Spell Check/com.darkrockstudios.texteditor.spellcheck.diagnostics

Package-level declarations

Types

data class DiagnosticFix(val replacement: String, val label: String = replacement)

A fix for a diagnostic: replacement for its range, shown on the menu as label. A label says what a fix does where the replacement alone would not, such as "Remove “the”" for an empty replacement.

DiagnosticSeverity

enum DiagnosticSeverity : Enum<DiagnosticSeverity>

DiagnosticStyle

data class DiagnosticStyle(val message: String, val fixes: List<DiagnosticFix>, val color: Color, val severity: DiagnosticSeverity = DiagnosticSeverity.Error, val layer: DecorationLayer = DiagnosticsLayer) : DecorationStyle

The underline of one diagnostic, on layer. It carries the diagnostic's message and fixes itself, so they move with the span as the text around it is edited. By default it is on the layer a TextDiagnosticsState reads, replaces and clears as its own; one on a layer of its own is left to that layer's owner.

LineDiagnostic

data class LineDiagnostic(val start: Int, val end: Int, val message: String, val fixes: List<DiagnosticFix> = emptyList(), val severity: DiagnosticSeverity = DiagnosticSeverity.Error)

An issue in one line, from start to end, as character offsets into the line.

TextDiagnosticsChecker

fun interface TextDiagnosticsChecker

Finds issues other than spelling, such as grammar, in lines of text.

TextDiagnosticsState

class TextDiagnosticsState(val textState: TextEditorState, checker: TextDiagnosticsChecker?, color: Color = DefaultDiagnosticColor, suggestionColor: Color = DefaultSuggestionColor, scanContext: CoroutineContext = Dispatchers.Default, cacheLines: Int = DEFAULT_CACHE_LINES)

Underlines what a TextDiagnosticsChecker finds in textState, line by line. Results are kept by line text, so after an edit only the lines that changed go to TextDiagnosticsChecker.check; TextDiagnosticsChecker.checkText sees the whole text every time. Pass it to com.darkrockstudios.texteditor.spellcheck.SpellCheckingTextEditor, which refreshes it as the text changes and opens a menu of the message and fixes on an underline. The underlines are on the diagnostics decoration layer, which it reads and replaces by line; a state made for the same editor later takes over the underlines an earlier one left.

Properties

DefaultDiagnosticColor

val DefaultDiagnosticColor: Color

The default underline color: blue, apart from spell check's red.

DefaultSuggestionColor

val DefaultSuggestionColor: Color

The default underline color of a DiagnosticSeverity.Suggestion: a muted gold.

Functions

LineDiagnostic

fun LineDiagnostic(start: Int, end: Int, message: String, fixes: List<String>): LineDiagnostic

A LineDiagnostic whose fixes are replacements, each shown as itself.

rememberTextDiagnosticsState

@Composable

fun rememberTextDiagnosticsState(textState: TextEditorState, checker: TextDiagnosticsChecker?, color: Color = DefaultDiagnosticColor, suggestionColor: Color = DefaultSuggestionColor): TextDiagnosticsState

Remembers a TextDiagnosticsState for textState, following checker and the colors as they change. Pass a stable checker: a new instance checks the whole text again.