Gramur

3.2.0-RC1

Gramur/net.archandle.gramur.parser/RuleBuilder

RuleBuilder

class RuleBuilder<N : Node>(name: String?)

A DSL builder for defining production rules within a Grammar.

RuleBuilder provides a fluent API for constructing Rule instances by defining one or more productions. Each production is built by chaining PatternElement DSL constructor calls (token, reference, sequence, etc.), followed by a call to produces to finalize each Production.

All productions must include at least one element, and all Rules must include at least one production. If these conditions are not met, an IllegalStateException is thrown when finalizing the RuleBuilder.

Parameters

N

The type of node produced by this rule's productions

name

The name of this rule (unique within a Grammar), or null for anonymous rules

Constructors

constructor(name: String?)

Functions

fun alternation(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds an AlternationElement that matches any one of the specified alternatives.

fun build(): Rule<N>

Finalizes the current production and returns the built Rule instance.

fun chain(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds a OneOrMoreElement that matches 1 or more times.

fun choice(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds an AlternationElement that matches any one of the specified alternatives.

fun concatenation(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds a SequenceElement that matches all specified elements in order.

inline fun element(crossinline element: () -> PatternElement): RuleBuilder<N>

fun element(element: PatternElement): RuleBuilder<N>

Adds a custom PatternElement to the current production.

fun <G : Node> group(pattern: RuleBuilder<G>.() -> Unit): RuleBuilder<N>

Adds an anonymous inline nonterminal rule reference.

fun leftRecursion(): RuleBuilder<N>

Marks the current production as left-recursive.

fun <G : Node> node(pattern: RuleBuilder<G>.() -> Unit): RuleBuilder<N>

Adds an anonymous inline nonterminal rule reference.

fun nonterminal(rule: () -> Rule<*>): RuleBuilder<N>

Adds a nonterminal ReferenceElement that matches the given rule.

fun oneOrMore(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds a OneOrMoreElement that matches 1 or more times.

fun option(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds an OptionalElement (matches 0 or 1 times).

fun <G : RuleBuilder<in Node.Generic>> G.produces(): G

Finalizes the current production with a default Generic node factory.

fun produces(producer: Node.ParserCapture.() -> N): RuleBuilder<N>

Finalizes the current Production with a Node factory function.

fun reference(rule: () -> Rule<*>): RuleBuilder<N>

Adds a nonterminal ReferenceElement that matches the given rule.

fun repeat(min: Int = 0, max: Int = Int.MAX_VALUE, pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds a RepeatableElement that matches between min and max occurrences.

fun sequence(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds a SequenceElement that matches all specified elements in order.

inline fun <T : Token> token(): RuleBuilder<N>

Adds a TokenElement that matches tokens of type T.

inline fun <T : Token> token(noinline predicate: (T) -> Boolean): RuleBuilder<N>

Adds a TokenElement that matches tokens of type T satisfying the given predicate.

fun token(lexeme: Lexeme<*>): RuleBuilder<N>

Adds a TokenElement that matches tokens produced by the specified lexeme.

fun zeroOrMore(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds a RepeatableElement that matches 0 or more times.

fun zeroOrOne(pattern: RuleBuilder<*>.() -> Unit): RuleBuilder<N>

Adds an OptionalElement (matches 0 or 1 times).