KTreeSitter/io.github.treesitter.ktreesitter

Package-level declarations

Types

data class InputEdit(val startByte: UInt, val oldEndByte: UInt, val newEndByte: UInt, val startPoint: Point, val oldEndPoint: Point, val newEndPoint: Point)

An edit to a text document.

InputEncoding

actual enum InputEncoding : Enum<InputEncoding>

The encoding of the input text.

expect enum InputEncoding : Enum<InputEncoding>

The encoding of the input text.

actual enum InputEncoding : Enum<InputEncoding>

The encoding of the input text.

actual enum InputEncoding : Enum<InputEncoding>

The encoding of the input text.

Language

actual class Language(language: Any)

A class that defines how to parse a particular language.

expect class Language(language: Any)

A class that defines how to parse a particular language.

actual class Language(language: Any)

A class that defines how to parse a particular language.

actual class Language(language: Any)

A class that defines how to parse a particular language.

LogFunction

typealias LogFunction = (type: Parser.LogType, message: String) -> Unit

A function that logs parsing results.

LookaheadIterator

actual class LookaheadIterator : AbstractIterator<LookaheadIterator.Symbol> , AutoCloseable

A class that is used to look up valid symbols in a specific parse state.

expect class LookaheadIterator : AbstractIterator<LookaheadIterator.Symbol>

A class that is used to look up valid symbols in a specific parse state.

actual class LookaheadIterator : AbstractIterator<LookaheadIterator.Symbol>

A class that is used to look up valid symbols in a specific parse state.

actual class LookaheadIterator : AbstractIterator<LookaheadIterator.Symbol>

A class that is used to look up valid symbols in a specific parse state.

Node

actual class Node

A single node within a syntax tree.

expect class Node

A single node within a syntax tree.

actual class Node

A single node within a syntax tree.

actual class Node

A single node within a syntax tree.

ParseProgressCallback

typealias ParseProgressCallback = (currentByteOffset: UInt, hasError: Boolean) -> Boolean

A function that is called during parsing.

Parser

actual class Parser : AutoCloseable

A class that is used to produce a syntax tree from source code.

expect class Parser

A class that is used to produce a syntax tree from source code.

actual class Parser

A class that is used to produce a syntax tree from source code.

actual class Parser

A class that is used to produce a syntax tree from source code.

ParseReadCallback

typealias ParseReadCallback = (byte: UInt, point: Point) -> CharSequence?

A function to retrieve a chunk of text at a given byte offset and point.

Point

data class Point(val row: UInt, val column: UInt) : Comparable<Point>

A position in a text document in terms of rows and columns.

Query

actual class Query(language: Language, source: String) : AutoCloseable

A class that represents a set of patterns which match nodes in a syntax tree.

expect class Query(language: Language, source: String)

A class that represents a set of patterns which match nodes in a syntax tree.

actual class Query(language: Language, source: String)

A class that represents a set of patterns which match nodes in a syntax tree.

actual class Query(language: Language, source: String)

A class that represents a set of patterns which match nodes in a syntax tree.

QueryCapture

data class QueryCapture

A Node that was captured with a certain capture name.

QueryCursor

actual class QueryCursor : AutoCloseable

A class that is used for executing a query.

expect class QueryCursor

A class that is used for executing a query.

actual class QueryCursor

A class that is used for executing a query.

actual class QueryCursor

A class that is used for executing a query.

QueryError

sealed class QueryError : IllegalArgumentException

Any error that occurred while instantiating a Query.

QueryMatch

class QueryMatch

A match that corresponds to a certain pattern in the query.

QueryPredicate

sealed class QueryPredicate

A query predicate that associates conditions or arbitrary metadata with a pattern.

QueryPredicateArg

sealed interface QueryPredicateArg

An argument to a QueryPredicate.

QueryProgressCallback

typealias QueryProgressCallback = (currentByteOffset: UInt) -> Boolean

A function that is called while executing a query.

Range

data class Range(val startPoint: Point, val endPoint: Point, val startByte: UInt, val endByte: UInt)

A range of positions in a text document, both in terms of bytes and of row-column points.

Tree

actual class Tree : AutoCloseable

A class that represents a syntax tree.

expect class Tree

A class that represents a syntax tree.

actual class Tree

A class that represents a syntax tree.

actual class Tree

A class that represents a syntax tree.

TreeCursor

actual class TreeCursor : AutoCloseable

A class that can be used to efficiently walk a syntax tree.

expect class TreeCursor

A class that can be used to efficiently walk a syntax tree.

actual class TreeCursor

A class that can be used to efficiently walk a syntax tree.

actual class TreeCursor

A class that can be used to efficiently walk a syntax tree.

Properties

LANGUAGE_VERSION

const val LANGUAGE_VERSION: UInt

The latest ABI version that is supported by the current version of the library.

MIN_COMPATIBLE_LANGUAGE_VERSION

const val MIN_COMPATIBLE_LANGUAGE_VERSION: UInt

The earliest ABI version that is supported by the current version of the library.