lezer-common/com.monkopedia.kodemirror.lezer.common/SyntaxNode

SyntaxNode

interface SyntaxNode : SyntaxNodeRef

A syntax node that provides navigation to parent and siblings.

Properties

firstChild

abstract val firstChild: SyntaxNode?

from

abstract val from: Int

lastChild

abstract val lastChild: SyntaxNode?

name

open val name: String

nextSibling

abstract val nextSibling: SyntaxNode?

parent

abstract val parent: SyntaxNode?

prevSibling

abstract val prevSibling: SyntaxNode?

abstract val to: Int

tree

abstract val tree: Tree?

Get the tree backing this node, if any.

type

abstract val type: NodeType

Functions

childAfter

abstract fun childAfter(pos: Int): SyntaxNode?

Navigate to a child after a position.

childBefore

abstract fun childBefore(pos: Int): SyntaxNode?

Navigate to a child before a position.

cursor

abstract fun cursor(): TreeCursor

Create a cursor from this node.

enter

abstract fun enter(pos: Int, side: Int, mode: Int = 0): SyntaxNode?

Enter the node from a position.

enterUnfinishedNodesBefore

abstract fun enterUnfinishedNodesBefore(pos: Int): SyntaxNode

Walk the tree back from a position, finding the innermost unfinished node (an error node) before the position.

getChild

abstract fun getChild(type: String, before: String? = null, after: String? = null): SyntaxNode?

Get a child by name (optionally between before/after).

getChildren

abstract fun getChildren(type: String, before: String? = null, after: String? = null): List<SyntaxNode>

Get all children matching a type.

matchContext

abstract fun matchContext(context: List<String>): Boolean

Match this node against a list of parent names (innermost last).

resolve

abstract fun resolve(pos: Int, side: Int = 0): SyntaxNode

Resolve to the innermost node at pos, moving up out of this node first when it does not cover pos. Does not enter overlays.

resolveInner

abstract fun resolveInner(pos: Int, side: Int = 0): SyntaxNode

Like resolve, but enters overlaid nodes to find the innermost node, and climbs back out of overlays that do not cover pos.

toTree

abstract fun toTree(): Tree

Convert this node to a standalone Tree.