quarkdown-core/com.quarkdown.core.ast.iterator/ObservableAstIterator

ObservableAstIterator

class ObservableAstIterator : AstIterator<Unit>

An iterator that performs a DFS traversal through the nodes of an AST, allowing the registration of observers that will be notified when a node of a certain type is visited.

Constructors

constructor()

Properties

hooks

val hooks: MutableList<(Node) -> Unit>

Hooks that will be called when a node of a certain type is visited.

Functions

attach

fun attach(hook: AstIteratorHook): ObservableAstIterator

Attaches a hook to this iterator.

collect

inline fun <T : Node> collect(crossinline condition: (T) -> Boolean): List<T>

Collects the visited nodes of type T into a collection, as long as they satisfy a condition.

collectAll

inline fun <T : Node> collectAll(): List<T>

Collects all the visited nodes of type T into a collection.

inline fun <T : Node> on(noinline hook: (T) -> Unit): ObservableAstIterator

Registers a hook that will be called when a node of type T is visited.

onFinished

fun onFinished(hook: () -> Unit): ObservableAstIterator

Registers a hook that will be called when the tree traversal fully finishes.

traverse

open override fun traverse(root: AstRoot)

Runs the iterator from the given root node, traversing the node tree and visiting each node.