lezer-highlight/com.monkopedia.kodemirror.lezer.highlight

Package-level declarations

Types

Highlighter

interface Highlighter

A highlighter defines a mapping from highlighting tags to style strings.

Rule

class Rule

Tag

class Tag

Highlighting tags are markers that denote a highlighting category. They are associated with parts of a syntax tree by a language mode, and then mapped to an actual style by a Highlighter.

Properties

classHighlighter

val classHighlighter: Highlighter

A pre-built Highlighter that maps highlighting tags to tok-* CSS class names.

ruleNodeProp

val ruleNodeProp: NodeProp<Rule>

The NodeProp that stores highlight rules on node types.

Functions

getStyleTags

fun getStyleTags(node: SyntaxNodeRef): Rule?

Match a syntax node's highlight rules. If there's a match, return its set of tags, and whether it is opaque or inheriting.

highlightCode

fun highlightCode(code: String, tree: Tree, highlighter: Highlighter, putText: (text: String, classes: String) -> Unit, putBreak: () -> Unit, from: Int = 0, to: Int = code.length)

Highlight the given code string using the provided tree and highlighter, calling putText for each piece of text with its CSS classes, and putBreak at line breaks.

highlightTree

fun highlightTree(tree: Tree, highlighter: Highlighter, putStyle: (from: Int, to: Int, classes: String) -> Unit, from: Int = 0, to: Int = tree.length)

Highlight the given tree with the given highlighter(s), calling putStyle for each styled range.

fun highlightTree(tree: Tree, highlighters: List<Highlighter>, putStyle: (from: Int, to: Int, classes: String) -> Unit, from: Int = 0, to: Int = tree.length)

styleTags

fun styleTags(spec: Map<String, Tag>): NodePropSource<Rule>

Associates highlighting Tags with node types via a selector spec.

styleTagsList

fun styleTagsList(spec: Map<String, List<Tag>>): NodePropSource<Rule>

Associates highlighting Tags with node types via a selector spec, where each entry maps a node selector to a list of Tags.

tagHighlighter

fun tagHighlighter(tagRules: List<TagStyleRule>, scope: (NodeType) -> Boolean? = null, all: String? = null): Highlighter

Define a Highlighter from an array of tag/class pairs.

TagStyleRule

fun TagStyleRule(tag: Tag, class: String): TagStyleRule