Gramur

3.2.0-RC1

Gramur/net.archandle.gramur.parser/Node/ParserCapture

ParserCapture

open class ParserCapture : Node

A mutable container for capturing tokens and nodes during production matching.

ParserCapture tracks tokens and nodes captured by a production during parsing. As elements are captured by patterns, they are added to the capture's children list. Once the production successfully captures its entire pattern, the elements captured are shared for immutable Node production according to the RuleBuilder.produces lambda (or a Generic node if no lambda is specified).

Inheritors

AlternationCapture

RepeatableCapture

Properties

open override var children: List<Node>

The child nodes and tokens captured by this node's production.

val isAlternation: Boolean

Returns true if this node is an AlternationCapture.

val isRepeatable: Boolean

Returns true if this node is a RepeatableCapture.

open val nodes: <Error class: unknown class>

Returns only the child subnodes, excluding tokens.

open lateinit var stack: List<ParserContext.Frame>

The parser stack frames active when this Node was created.

open val tokens: <Error class: unknown class>

Returns only the tokens directly captured by this node, excluding tokens captured by subnodes.

Functions

fun addNode(node: Node): Node.ParserCapture

Adds a node to this capture's children.

fun addToken(token: Token): Node.ParserCapture

Adds a token to this capture's children.

fun <R> asAlternation(block: Node.AlternationCapture.() -> R): R?

Executes the block with this node as an AlternationCapture receiver if it is one.

fun <R> asRepeatable(block: Node.RepeatableCapture.() -> R): R?

Executes the block with this node as a RepeatableCapture receiver if it is one.

fun isNodeAt(index: Int): Boolean

Returns true if the child at index is a node (excluding TokenNode).

fun isNodeAt(index: Int, predicate: (node: Node) -> Boolean): Boolean

Returns true if the child at index is a node that satisfies the predicate.

inline fun <N : Node> isNodeAtAs(index: Int): Boolean

Returns true if the child at index is a node of type N.

inline fun <N : Node> isNodeAtAs(index: Int, noinline predicate: (node: N) -> Boolean): Boolean

Returns true if the child at index is a node of type N that satisfies the predicate.

fun isTokenAt(index: Int): Boolean

Returns true if the child at index is a token (i.e. a TokenNode).

fun isTokenAt(index: Int, predicate: (token: Token) -> Boolean): Boolean

Returns true if the child at index is a token that satisfies the predicate.

inline fun <T : Token> isTokenAtAs(index: Int): Boolean

Returns true if the child at index is a token of type T.

inline fun <T : Token> isTokenAtAs(index: Int, noinline predicate: (token: T) -> Boolean): Boolean

Returns true if the child at index is a token of type T that satisfies the predicate.

fun nodeAt(index: Int): Node

Returns the child node at the specified index in this node's children.

inline fun <N : Node> nodeAtAs(index: Int): N

Returns the child node at the specified index, cast to type N.

open fun tokenAt(index: Int): Token

Returns the Token at the specified index in this node's children.

inline fun <T : Token> tokenAtAs(index: Int): T

Returns the Token at the specified index, cast to type T.

tokensRecursively

open fun tokensRecursively(): <Error class: unknown class>

Returns all tokens captured by this Node, and its descendant subnodes, recursively.