Class Nonterminal

Namespace

Farkle.Builder.Untyped

Assembly

Farkle.dll

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

public sealed class Nonterminal : IGrammarSymbol, IGrammarBuilder

Inheritance

object

Nonterminal

Implements

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)

GrammarSymbolExtensions.AddSpecialName(IGrammarSymbol, string)

GrammarSymbolExtensions.Cast(IGrammarSymbol)

ProductionBuilderExtensions.Appended(IGrammarSymbol)

ProductionBuilderExtensions.FinishConstant<T>(IGrammarSymbol, T)

ProductionBuilderExtensions.Finish<T>(IGrammarSymbol, Func<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 ProductionBuilder[])

Sets the productions of this nonterminal.

public void SetProductions(params ProductionBuilder[] productions)

Parameters

productions ProductionBuilder[]

An array with the productions to set. The productions are represented as ProductionBuilder objects that have not been Extended or Finished.

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<ProductionBuilder>)

Sets the productions of this nonterminal.

public void SetProductions(params ImmutableArray<ProductionBuilder> productions)

Parameters

productions ImmutableArray<ProductionBuilder>

The productions to set. The productions are represented as ProductionBuilder objects that have not been Extended or Finished.

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.