MergableLexerBase Class

public abstract class MergableLexerBase : IMergableLexer, ILexer, IKeyedObject

protected MergableLexerBase()

protected ILexicalState DefaultLexicalStateCore { get; set; }

Property Value

ILexicalState:

The root ILexicalState for when the language is entered.

protected string KeyCore { get; set; }

Property Value

String:

A string that identifies the lexer, generally the related language name.

protected ILexicalStateIdProvider LexicalStateIdProviderCore { get; set; }

Property Value

ILexicalStateIdProvider:

The ILexicalStateIdProvider that provides access to all the lexical state IDs and keys used by this lexer.

protected ITokenIdProvider TokenIdProviderCore { get; set; }

Property Value

ITokenIdProvider:

The ITokenIdProvider that provides access to all the token IDs and keys used by this lexer.

public IDisposable CreateChangeBatch()

Returns

IDisposable:

An IDisposable object. Once disposed, the batch is ended.

public virtual IMergableToken CreateDocumentEndToken(int startOffset, TextPosition startPosition, ILexicalState lexicalState)

Parameter	Type	Description
startOffset	Int32	The start offset of the IToken.
startPosition	TextPosition	The start TextPosition of the IToken.
lexicalState	ILexicalState	The ILexicalState that contains the token.

Returns

IMergableToken:

An IMergableToken that represents the end of a document.

public virtual IMergableToken CreateToken(int startOffset, int length, TextPosition startPosition, TextPosition endPosition, MergableLexerFlags lexerFlags, ILexicalState lexicalState, IMergableTokenLexerData lexerData)

Parameter	Type	Description
startOffset	Int32	The start offset of the token.
length	Int32	The length of the token.
startPosition	TextPosition	The TextPosition of the first character in the token.
endPosition	TextPosition	The TextPosition after the last character in the token.
lexerFlags	MergableLexerFlags	The MergableLexerFlags for the token.
lexicalState	ILexicalState	The ILexicalState that contains the token.
lexerData	IMergableTokenLexerData	The IMergableTokenLexerData that contains lexer information about the token.

Returns

IMergableToken:

An IMergableToken that represents the range of text with the specified lexer data.

public abstract IEnumerable<ILexicalStateTransition> GetAllLexicalStateTransitions()

Returns

IEnumerable<ILexicalStateTransition>:

A collection containing all ILexicalStateTransition objects within the lexer.

Remarks

This method allows consumers to see which language transitions can be made within the lexer.

public virtual MergableLexerResult GetDefaultToken(ITextBufferReader reader, ILexicalState lexicalState)

Parameter	Type	Description
reader	ITextBufferReader	An ITextBufferReader that is reading a text source.
lexicalState	ILexicalState	The ILexicalState that specifies the current state.

Returns

MergableLexerResult:

A MergableLexerResult indicating the lexer result.

protected virtual TextSnapshotRange GetIncrementalParseRange(TextSnapshotRange snapshotRange)

Parameter	Type	Description
snapshotRange	TextSnapshotRange	The requested TextSnapshotRange to incrementally parse.

Returns

TextSnapshotRange:

The actual TextSnapshotRange to incrementally parse.

Remarks

When performing incremental parsing, a larger snapshot range than the actual modified snapshot range should usually be parsed. For instance, if the end user types text at the end of a word that should make the word a keyword, incremental parsing should start at least at the start of the word or else it won't be recognized as a keyword.

The default implementation of this method starts incremental parsing at the start of the line at which the requested snapshot range begins.

This method is called by the default Parse(TextSnapshotRange, ILexerTarget) implementation to modify the snapshot range to parse.

public abstract MergableLexerResult GetNextToken(ITextBufferReader reader, ILexicalState lexicalState)

Parameter	Type	Description
reader	ITextBufferReader	An ITextBufferReader that is reading a text source.
lexicalState	ILexicalState	The ILexicalState that specifies the current state.

Returns

MergableLexerResult:

A MergableLexerResult indicating the lexer result.

protected virtual void OnChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	The EventArgs that contains the event data.

public virtual TextRange Parse(TextSnapshotRange snapshotRange, ILexerTarget parseTarget)

Parameter	Type	Description
snapshotRange	TextSnapshotRange	A TextSnapshotRange indicating the offset range to parse.
parseTarget	ILexerTarget	The ILexerTarget that receives the parsing output.

Returns

TextRange:

A TextRange containing the offset range that was modified.

public event EventHandler Changed

Event Type

EventHandler

ITokenIdProvider ILexer.TokenIdProvider { get; }

Returns

ITokenIdProvider:

The ITokenIdProvider that provides access to all the token IDs and keys used by this lexer.

ILexicalState IMergableLexer.DefaultLexicalState { get; }

Returns

ILexicalState:

The root ILexicalState for when the language is entered.

ILexicalStateIdProvider IMergableLexer.LexicalStateIdProvider { get; }

Returns

ILexicalStateIdProvider:

The ILexicalStateIdProvider that provides access to all the lexical state IDs and keys used by this lexer.

string IKeyedObject.Key { get; }

Returns

String:

A string that identifies the lexer, generally the related language name.