core/com.strumenta.kolasu.traversing

Package-level declarations

Types

class FastWalker(val node: Node)

The FastWalker is a walker that implements a cache to speed up subsequent walks. The first walk will take the same time of a normal walk. This walker will ignore any change to the nodes.

typealias Stack<T> = Deque<T>

Some Kotlinization of Deques used as a stack.

Functions

fun <T> Node.collectByType(klass: Class<T>, walker: (Node) -> Sequence<Node> = Node::walk): List<T>

T is not forced to be a subtype of Node to support using interfaces.

findAncestorOfType

fun <T> Node.findAncestorOfType(klass: Class<T>): T?

Note that type T is not strictly forced to be a Node. This is intended to support interfaces like Statement or Expression. However, being an ancestor the returned value is guaranteed to be a Node, as only Node instances can be part of the hierarchy.

fun Node.findByRange(range: Range, selfContained: Boolean = false): Node?

fun <T> mutableStackOf(): Stack<T>

fun <T> mutableStackOf(vararg elements: T): Stack<T>

fun <T> Stack<T>.pushAll(elements: Collection<T>)

fun Node.searchByRange(range: Range, selfContained: Boolean = false): Sequence<Node>

fun <T> Node.searchByType(klass: Class<T>, walker: (Node) -> Sequence<Node> = Node::walk): Sequence<T>

fun Node.walk(): Sequence<Node>

Traverse the entire tree, deep first, starting from this Node.

fun Node.walkAncestors(): Sequence<Node>

fun Node.walkChildren(): Sequence<Node>

walkDescendants

fun Node.walkDescendants(walker: (Node) -> Sequence<Node> = Node::walk): Sequence<Node>

fun <N : Any> Node.walkDescendants(type: KClass<N>, walker: (Node) -> Sequence<Node> = Node::walk): Sequence<N>

walkLeavesFirst

fun Node.walkLeavesFirst(): Sequence<Node>

Performs a post-order (or leaves-first) node traversal starting with a given node.

fun Node.walkWithin(range: Range): Sequence<Node>

fun List<Node>.walkWithin(range: Range): Sequence<Node>

Properties

val Node.children: List<Node>