Class Nonterminal<T>

Namespace

Farkle.Builder

Assembly

Farkle.dll

Represents a nonterminal symbol in a grammar to be built that produces a value, and allows setting its productions after its creation.

public sealed class Nonterminal<T> : IGrammarSymbol<T>, IGrammarBuilder<T>, IGrammarSymbol, IGrammarBuilder

Type Parameters

T

The type of values the nonterminal will produce.

Inheritance

object

Nonterminal<T>

Implements

IGrammarSymbol<T>

IGrammarBuilder<T>

IGrammarSymbol

IGrammarBuilder

Extension Methods

GrammarBuilderExtensions.AddBlockComment(IGrammarBuilder, string, string)

GrammarBuilderExtensions.AddLineComment(IGrammarBuilder, string)

GrammarBuilderExtensions.AddNoiseSymbol(IGrammarBuilder, string, Regex)

GrammarBuilderExtensions.AutoWhitespace(IGrammarBuilder, bool)

GrammarBuilderExtensions.BuildSyntaxCheck(IGrammarBuilder, BuilderArtifacts, BuilderOptions?)

GrammarBuilderExtensions.BuildSyntaxCheck(IGrammarBuilder, BuilderOptions?)

GrammarBuilderExtensions.BuildSyntaxCheck<T>(IGrammarBuilder, BuilderArtifacts, BuilderOptions?)

GrammarBuilderExtensions.BuildSyntaxCheck<T>(IGrammarBuilder, BuilderOptions?)

GrammarBuilderExtensions.CaseSensitive(IGrammarBuilder, CaseSensitivity)

GrammarBuilderExtensions.CaseSensitive(IGrammarBuilder, bool)

GrammarBuilderExtensions.Cast(IGrammarBuilder)

GrammarBuilderExtensions.NewLineIsNoisy(IGrammarBuilder, bool)

GrammarBuilderExtensions.WithGrammarName(IGrammarBuilder, string)

GrammarBuilderExtensions.WithOperatorScope(IGrammarBuilder, params AssociativityGroup[])

GrammarBuilderExtensions.WithOperatorScope(IGrammarBuilder, params OperatorScope)

GrammarBuilderExtensions.AddBlockComment<T>(IGrammarBuilder<T>, string, string)

GrammarBuilderExtensions.AddLineComment<T>(IGrammarBuilder<T>, string)

GrammarBuilderExtensions.AddNoiseSymbol<T>(IGrammarBuilder<T>, string, Regex)

GrammarBuilderExtensions.AutoWhitespace<T>(IGrammarBuilder<T>, bool)

GrammarBuilderExtensions.Build<T>(IGrammarBuilder<T>, BuilderArtifacts, BuilderOptions?)

GrammarBuilderExtensions.Build<T>(IGrammarBuilder<T>, BuilderOptions?)

GrammarBuilderExtensions.CaseSensitive<T>(IGrammarBuilder<T>, CaseSensitivity)

GrammarBuilderExtensions.CaseSensitive<T>(IGrammarBuilder<T>, bool)

GrammarBuilderExtensions.NewLineIsNoisy<T>(IGrammarBuilder<T>, bool)

GrammarBuilderExtensions.WithGrammarName<T>(IGrammarBuilder<T>, string)

GrammarBuilderExtensions.WithOperatorScope<T>(IGrammarBuilder<T>, params AssociativityGroup[])

GrammarBuilderExtensions.WithOperatorScope<T>(IGrammarBuilder<T>, params OperatorScope)

GrammarSymbolExtensions.AddSpecialName(IGrammarSymbol, string)

GrammarSymbolExtensions.Cast(IGrammarSymbol)

ProductionBuilderExtensions.Appended(IGrammarSymbol)

ProductionBuilderExtensions.FinishConstant<T>(IGrammarSymbol, T)

ProductionBuilderExtensions.Finish<T>(IGrammarSymbol, Func<T>)

GrammarSymbolExtensions.AddSpecialName<T>(IGrammarSymbol<T>, string)

GrammarSymbolExtensions.Many<T, TCollection>(IGrammarSymbol<T>, bool)

GrammarSymbolExtensions.Optional<T>(IGrammarSymbol<T>)

GrammarSymbolExtensions.Select<T, TNew>(IGrammarSymbol<T>, Func<T, TNew>, string?)

GrammarSymbolExtensions.SeparatedBy<T, TCollection>(IGrammarSymbol<T>, IGrammarSymbol, bool)

ProductionBuilderExtensions.AsProduction<T>(IGrammarSymbol<T>)

ProductionBuilderExtensions.Extended<T1>(IGrammarSymbol<T1>)

ProductionBuilderExtensions.Finish<T1, T>(IGrammarSymbol<T1>, Func<T1, T>)

Remarks

In Farkle, builder objects are usually immutable. This exception exists to support defining recursive nonterminals.

Properties

Name

The symbol's name.

public string Name { get; }

Property Value

string

Remarks

This value is used only for diagnostic and documentation purposes and does not affect the grammar's behavior when parsing. A grammar may contain multiple symbols with the same name.

Methods

SetProductions(params IProduction<T>[])

Sets the productions of this nonterminal.

public void SetProductions(params IProduction<T>[] productions)

Parameters

productions IProduction<T>[]

An array with the productions to set.

Remarks

This function and its overloads must be called exactly once, and before the nonterminal is used in building a grammar.

Exceptions

ArgumentException

productions is empty.

InvalidOperationException

The productions have already been successfully set.

SetProductions(params ImmutableArray<IProduction<T>>)

Sets the productions of this nonterminal.

public void SetProductions(params ImmutableArray<IProduction<T>> productions)

Parameters

productions ImmutableArray<IProduction<T>>

The productions to set.

Remarks

This function and its overloads must be called exactly once, and before the nonterminal is used in building a grammar.

Exceptions

ArgumentException

productions is empty.

InvalidOperationException

The productions have already been successfully set.