Grammar (Farkle)

Grammar Type

Namespace: Farkle.Grammar
Assembly: Farkle.dll
Base Type: obj
All Interfaces: IGrammarProvider

A context-free grammar according to which Farkle can parse text.

Record fields

Record Field	Description
`_DFAStates` Full Usage: `_DFAStates` Field type: `ImmutableArray<DFAState>`	Field type: `ImmutableArray<DFAState>`
`_Groups` Full Usage: `_Groups` Field type: `ImmutableArray<Group>`	Field type: `ImmutableArray<Group>`
`_LALRStates` Full Usage: `_LALRStates` Field type: `ImmutableArray<LALRState>`	Field type: `ImmutableArray<LALRState>`
`_Productions` Full Usage: `_Productions` Field type: `ImmutableArray<Production>`	Field type: `ImmutableArray<Production>`
`_Properties` Full Usage: `_Properties` Field type: `GrammarProperties`	Field type: `GrammarProperties`
`_StartSymbol` Full Usage: `_StartSymbol` Field type: `Nonterminal`	Field type: `Nonterminal`
`_Symbols` Full Usage: `_Symbols` Field type: `Symbols`	Field type: `Symbols`

Instance members

Instance member Description


                
                  
                    
                      this.DFAStates

Full Usage: this.DFAStates

Returns: ImmutableArray<DFAState>

The grammar's DFA state table.

Returns: ImmutableArray<DFAState>


                
                  
                    
                      this.GetTerminalByName

Full Usage: this.GetTerminalByName

Parameters:

name : string - The terminal's name.

Returns: Terminal

Finds a Terminal with a specific name.

This method is useful for those that write custom Tokenizer. It executes in linear time. For this reason, it is advised to be called once per terminal name.

name : string: The terminal's name.

Returns: Terminal

ArgumentOutOfRangeException	No terminal named name exists.
InvalidOperationException	Many terminals named name exist.


                
                  
                    
                      this.Groups

Full Usage: this.Groups

Returns: ImmutableArray<Group>

The grammar's `Group`s.

Returns: ImmutableArray<Group>


                
                  
                    
                      this.LALRStates

Full Usage: this.LALRStates

Returns: ImmutableArray<LALRState>

The grammar's LALR state table.

Returns: ImmutableArray<LALRState>


                
                  
                    
                      this.Productions

Full Usage: this.Productions

Returns: ImmutableArray<Production>

The grammar's `Production`s.

Returns: ImmutableArray<Production>


                
                  
                    
                      this.Properties

Full Usage: this.Properties

Returns: GrammarProperties

Additional information about the grammar.

Returns: GrammarProperties


                
                  
                    
                      this.StartSymbol

Full Usage: this.StartSymbol

Returns: Nonterminal

The grammar's start `Nonterminal`.

Returns: Nonterminal


                
                  
                    
                      this.Symbols

Full Usage: this.Symbols

Returns: Symbols

The grammar's terminals, nonterminals, and noise symbols.

Returns: Symbols