Add(String,String,TerminalSymbolComparison,Boolean) Method

Adds a new TerminalSymbol to the collection with the specified name.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function Add( _
   ByVal name As String, _
   Optional ByVal value As String, _
   Optional ByVal comparison As TerminalSymbolComparison, _
   Optional ByVal isExitSymbol As Boolean _
) As TerminalSymbol

C#

public TerminalSymbol Add( 
   string name,
   string value,
   TerminalSymbolComparison comparison,
   bool isExitSymbol
)

Parameters

name

The Symbol.Name of the new symbol.

value

The text which must be matched for the terminal symbol to be recognized within the text. If null, the name will be used as the value.

comparison

Indicates how the text should be interpreted: as a case-sensitive literal string, a case-insensitive literal string, or a regular expression.

isExitSymbol

Indicates whether the symbol should be an exit symbol for the lexer state.

Return Value

The TerminalSymbol instance which was added to the collection.

Exceptions

Exception	Description
System.InvalidOperationException	Occurs when the owning LexerState does not belong to a Grammar.
System.InvalidOperationException	Occurs when the IsMutable value of the owning Grammar is False.
System.ArgumentNullException	Occurs when name is null or empty.
System.ArgumentException	Occurs when a symbol of the owning Grammar already exists with the specified name.
System.ArgumentException	Occurs when comparison is not defined in the TerminalSymbolComparison enumeration.
System.ArgumentException	Occurs when isExitSymbol is True and the owning LexerState is the default lexer state.

Remarks

If the LexerState owning the collection is not the default lexer state, the symbol can optionally be added as an exit symbol. If it is an exit symbol, the lexer state will be exited when tokens associated with the symbol are created by the lexer. When a lexer state is exited, the lexer will go back to the state it was in before the state was entered. A LexerState will be entered when a token is created which is associated with a TerminalSymbol that has a TerminalSymbol.LexerStateToEnter set. If a TerminalSymbol is both an exit symbol and it has a LexerStateToEnter set, the LexerStateToEnter will be ignored. The lexer cannot enter and exit a state at the same time and exiting a lexer state takes precedence.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2