KTreeSitter/io.github.treesitter.ktreesitter/Tree

Tree

actual class Tree : AutoCloseable(source)

A class that represents a syntax tree.

NOTE: If you're targeting Android SDK level < 33, you must use or close the instance to free up resources.

expect class Tree(source)

A class that represents a syntax tree.

actual class Tree(source)

A class that represents a syntax tree.

actual class Tree(source)

A class that represents a syntax tree.

Properties

includedRanges

actual val includedRanges: List<Range>

The included ranges that were used to parse the syntax tree.

expect val includedRanges: List<Range>

The included ranges that were used to parse the syntax tree.

actual val includedRanges: List<Range>

The included ranges that were used to parse the syntax tree.

actual val includedRanges: List<Range>

The included ranges of the syntax tree.

language

actual val language: Language

The language that was used to parse the syntax tree.

expect val language: Language

The language that was used to parse the syntax tree.

actual val language: Language

The language that was used to parse the syntax tree.

actual val language: Language

The language that was used to parse the syntax tree.

rootNode

actual val rootNode: Node

The root node of the syntax tree.

expect val rootNode: Node

The root node of the syntax tree.

actual val rootNode: Node

The root node of the syntax tree.

actual val rootNode: Node

The root node of the syntax tree.

Functions

changedRanges

actual external fun changedRanges(newTree: Tree): List<Range>

Compare an old edited syntax tree to a new syntax tree representing the same document.

expect fun changedRanges(newTree: Tree): List<Range>

Compare an old edited syntax tree to a new syntax tree representing the same document.

actual external fun changedRanges(newTree: Tree): List<Range>

Compare an old edited syntax tree to a new syntax tree representing the same document.

actual fun changedRanges(newTree: Tree): List<Range>

Compare an old edited syntax tree to a new syntax tree representing the same document.

open override fun close()

copy

actual fun copy(): Tree

Create a shallow copy of the syntax tree.

expect fun copy(): Tree

Create a shallow copy of the syntax tree.

actual fun copy(): Tree

Create a shallow copy of the syntax tree.

actual fun copy(): Tree

Create a shallow copy of the syntax tree.

edit

actual external fun edit(edit: InputEdit)

Edit the syntax tree to keep it in sync with source code that has been modified.

expect fun edit(edit: InputEdit)

Edit the syntax tree to keep it in sync with source code that has been modified.

actual external fun edit(edit: InputEdit)

Edit the syntax tree to keep it in sync with source code that has been modified.

actual fun edit(edit: InputEdit)

Edit the syntax tree to keep it in sync with source code that has been modified.

rootNodeWithOffset

@JvmName(name = "rootNodeWithOffset")

actual external fun rootNodeWithOffset(bytes: UInt, extent: Point): Node?

Get the root node of the syntax tree, but with its position shifted forward by the given offset.

expect fun rootNodeWithOffset(bytes: UInt, extent: Point): Node?

Get the root node of the syntax tree, but with its position shifted forward by the given offset.

@JvmName(name = "rootNodeWithOffset")

actual external fun rootNodeWithOffset(bytes: UInt, extent: Point): Node?

Get the root node of the syntax tree, but with its position shifted forward by the given offset.

actual fun rootNodeWithOffset(bytes: UInt, extent: Point): Node?

Get the root node of the syntax tree, but with its position shifted forward by the given offset.

text

actual fun text(): CharSequence?

Get the source code of the syntax tree, if available.

expect fun text(): CharSequence?

Get the source code of the syntax tree, if available.

actual fun text(): CharSequence?

Get the source code of the syntax tree, if available.

actual fun text(): CharSequence?

Get the source code of the syntax tree, if available.

toString

open override fun toString(): String

walk

actual fun walk(): TreeCursor

Create a new tree cursor starting from the node of the tree.

expect fun walk(): TreeCursor

Create a new tree cursor starting from the node of the tree.

actual fun walk(): TreeCursor

Create a new tree cursor starting from the node of the tree.

actual fun walk(): TreeCursor

Create a new tree cursor starting from the node of the tree.