TClientSyntAnalyzer Class

Performs syntactical analysis for a single client of the TSyntAnalyzer component.

TClientSyntAnalyzer = class(TParserResults);

File

ecSyntAnal

Description

TClientSyntAnalyzer object is created for any client of TSyntAnalyzer component in TSyntAnalyzer.AddClient function.

TClientSyntAnalyzer implements analyzing loop that calls GetToken and SelectTokenFormat methods of the TSyntAnalyzer. TClientSyntAnalyzer stores all results of syntactical analysis in arrays within self.

You can access these objects through properties of the TClientSyntAnalyzer object.

To get events of the syntactical analyzer you have to implement IecSyntClient interface in your class and client in TCustomSyntaxMemo or TSyntTextSource depending on what object is a container of analyzer.

To get reference to TClientSyntAnalyzer object use properties TCustomSyntaxMemo.SyntObj or TSyntTextSource.SyntObj.

Group

Classes

Topics

Topic	Description
TParserResults Methods	The methods of the TParserResults class are listed here.
TParserResults Properties	The properties of the TParserResults class are listed here.

TClientSyntAnalyzer Class

Topic	Description
TClientSyntAnalyzer Methods	The methods of the TClientSyntAnalyzer class are listed here.
TClientSyntAnalyzer Properties	The properties of the TClientSyntAnalyzer class are listed here.

Legend

	Method
	protected
	virtual
	abstract
	Property
	read only

TParserResults Methods

TParserResults Methods	Description
AnalyzerAtPos	Returns active analyzer at the specified position.
ApplyStates	Apply states modifiers of rule.
Clear	Destroys all results of syntactical analysis.
CloseAtEnd	Closes text ranges at end of text.
Create	Creates and initializes a TParserResults instance.
Destroy	Destroys an instance of TParserResults.
Finished	Performs operations at the end of syntactical analysis.
ParserStateAtPos	Returns parser states flags at token position TokenIndex.
RestoreState	Restores parser state to be valid for current token buffer.
SaveState	Saves changes of parser state.

TClientSyntAnalyzer Class

TClientSyntAnalyzer Class	Description
AddLineBreak	Adds new line separator.
AddRange	Adds new text range.
Analyze	Performs syntactical analysis of whole text.
AppendToPos	Forces syntactical analysis to specified position.
ChangedAtPos	Destroys all syntactical results for text from specified position.
Clear	Destroys all results of syntactical analysis.
CloseAtEnd	Closes text ranges at end of text.
CloseRange	Closes text range that refers to end block rule Cond.
CompleteAnalysis	Completes syntactical analysis without resting current state of analyzer.
Create	Creates and initializes a TClientSyntAnalyzer instance.
CreateLineBreak	Add new line break.
Destroy	Destroys an instance of TClientSyntAnalyzer.
DetectTag	Detects tag and update token type.
Finished	Performs operations at the end of syntactical analysis.
GetAutoCloseText	Returns text to be inserted when auto closing opened text range.
GetCollapsedText	Returns a formatted string assembled from a collapsed text icon formatting string.
GetColRangeBound	Returns bounds of text range to be collapsed.
GetLineBreak	Returns line separator for the specified line index.
GetLineHighlight	Returns line highlighting attributes for the specified line index.
GetLineState	Returns folding state for the specified line index.
GetNearestColRange	Returns nearest collapsible text range. Used by smCollapse command.
GetRangeAtLine	Returns text range that starts at the specified line.
GetRangeBound	Returns text range bounds.
GetRangeGroup	Formatting string is defined in Range.Rule.GroupFmt property. Indexing reference points are defined by the Range. See "Name formatting" to get more information.
GetRangeName	Returns a formatted string assembled from a name formatting string.
GetRangeStyles	Retrieves text range styles at the specified position.
GetStapleLines	Returns first and last line of the Staple.
GetStaples	Returns list of staples which passes the Line.
GetTokenStyle	Retrieves token style at the specified position.
HasOpened	Tests whether there is opened text range with specified rule.
IdleAppend	Turns on idle syntactical analysis.
IntIdleAppend	Starts idle syntactical analysis.
IsEnabled	Checks wether Rule is enabled for the current analyzing position.
Lock	Locks meta-data (parser results) modification.
NearestRangeAtPos	Returns nearest (i.e. top level) text range that contains position APos.
NearestRangeIdxAtPos	Returns index of nearest (i.e. top level) text range that contains position APos.
NextTokenAt	Returns index of token which contains position Pos or placed after it.
PriorTokenAt	Returns index of token which contains position Pos or placed before it.
RangeAtPos	Returns text range that starts at specified position.
RangeFormat	Formats string FmtStr for specified text range. See Name formatting (for block rules) topic to get more information about range names formatting.
RangeIdxAtPos	Returns index of text range which starts at position APos.
ResetStaples	Resets (set to -1) XPos of all staples.
SetCurPos	Called when caret position is changed.
TokenAtPos	Returns index of the token at the specified position.
TryAppend	Forces syntactical analysis to specified position.
Unlock	Unlocks meta-data (parser results) modification.
UpdateDyno	Updates dynamically highlighted objects.

TParserResults Properties

TParserResults Properties	Description
IsFinished	Indicates whether syntactical analysis of the whole text is finished.
Owner	Indicates Owner of the analyzer object.
ParserState	Current parser state.
SubLexerRangeCount	Indicates the number of sub-lexer ranges in the list that are in use.
SubLexerRanges	Provides indexed access to sub-lexer ranges.
TagCount	Indicates tokens count.
Tags	Provides indexed access to tokens.
TagStr	Provides indexed access to token strings.

TClientSyntAnalyzer Class

TClientSyntAnalyzer Class	Description
DisableIdleAppend	Disable idle analysis of the text.
OpenCount	Indicates number of opened text ranges.
Opened	Provides indexed access to opened ranges.
RangeCount	Indicates all text ranges count.
Ranges	Provides indexed access to all text ranges.
TagPos	Returns position of tag in text.

Links

Classes, Legend, Members, Topics, TClientSyntAnalyzer Methods, TClientSyntAnalyzer Properties, TParserResults Methods, TParserResults Properties

Contents | Index

What do you think about this topic? Send feedback!