C# Class Microsoft.R.Editor.Outline.ROutlineRegionBuilder

Code outline region builder. Runs asynchronously but starts on next idle slot after the most recent tree change.

Inheritance: Microsoft.Languages.Editor.Outline.OutlineRegionBuilder, IAstVisitor

Show file Open project: Microsoft/RTVS Class Usage Examples

Private Properties

Property	Type	Description
OnDocumentClosing	void
OnEditorTreeClosing	void
OnTreeUpdateCompleted	void
OutlineNode	bool
OutlineRange	bool
OutlineSections	void

Public Methods

Method	Description
BuildRegions ( OutlineRegionCollection newRegions ) : bool
ROutlineRegionBuilder ( IREditorDocument document, IEditorShell shell ) : System
Visit ( IAstNode node, object param ) : bool

Protected Methods

Method	Description
CompareRegions ( OutlineRegionCollection newRegions, OutlineRegionCollection oldRegions, int upperBound ) : ITextRange
Dispose ( bool disposing ) : void
MainThreadAction ( object backgroundProcessingResult ) : void
OnTextBufferChanged ( object sender, TextContentChangedEventArgs e ) : void

Private Methods

Method	Description
OnDocumentClosing ( object sender, EventArgs e ) : void
OnEditorTreeClosing ( object sender, EventArgs e ) : void
OnTreeUpdateCompleted ( object sender, TreeUpdatedEventArgs e ) : void
OutlineNode ( IAstNode node, int &startLineNumber, int &endLineNumber ) : bool	Determines if particular AST node produces collapsible region
OutlineRange ( ITextSnapshot snapshot, ITextRange range, int &startLineNumber, int &endLineNumber ) : bool	Determines if range is large enough to be outlined
OutlineSections ( AstRoot ast, OutliningContext context ) : void	Outlines comments that define sections such as # NAME ---

Method Details

BuildRegions() public method

public BuildRegions ( OutlineRegionCollection newRegions ) : bool
newRegions	OutlineRegionCollection
return	bool

CompareRegions() protected method

protected CompareRegions ( OutlineRegionCollection newRegions, OutlineRegionCollection oldRegions, int upperBound ) : ITextRange
newRegions	OutlineRegionCollection
oldRegions	OutlineRegionCollection
upperBound	int
return	ITextRange

Dispose() protected method

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

MainThreadAction() protected method

protected MainThreadAction ( object backgroundProcessingResult ) : void
backgroundProcessingResult	object
return	void

OnTextBufferChanged() protected method

protected OnTextBufferChanged ( object sender, TextContentChangedEventArgs e ) : void
sender	object
e	TextContentChangedEventArgs
return	void

ROutlineRegionBuilder() public method

public ROutlineRegionBuilder ( IREditorDocument document, IEditorShell shell ) : System
document	IREditorDocument
shell	IEditorShell
return	System

Visit() public method

public Visit ( IAstNode node, object param ) : bool
node	IAstNode
param	object
return	bool