/// <summary>
/// parser the text buffer
/// </summary>
/// <param name="parser">buffer parser</param>
/// <returns>text region tree</returns>
public TextRegion ParseBuffer(SnapshotParser parser)
{
TextRegion regionTree = new TextRegion();
while (ParseBuffer(parser, regionTree) != null)
{
;
}
return(regionTree);
}
/// <summary>
/// Tries to move region start point up to get C#-like outlining
///
/// for (var k in obj)
/// { -- from here
///
/// for (var k in obj) -- to here
/// {
/// </summary>
private void ExtendStartPoint(TextRegion r)
{
//some are not extended
if (r.RegionType == TextRegionType.Region ||
r.RegionType == TextRegionType.Comment ||
!r.Complete ||
r.StartLine.LineNumber == r.EndLine.LineNumber ||
!string.IsNullOrWhiteSpace(r.TextBefore))
{
return;
}
//how much can we move region start
int upperLimit = 0;
if (r.Parent != null)
{
int childPosition = r.Parent.Children.IndexOf(r);
if (childPosition == -1)
{
childPosition = r.Parent.Children.Count;
}
if (childPosition == 0)
{
//this region is first child of its parent
//we can go until the parent's start
upperLimit = r.Parent.RegionType != TextRegionType.None ? r.Parent.StartLine.LineNumber + 1 : 0;
}
else
{
//there is previous child
//we can go until its end
TextRegion prevRegion = r.Parent.Children[childPosition - 1];
upperLimit = prevRegion.EndLine.LineNumber + (prevRegion.EndLine.LineNumber == prevRegion.StartLine.LineNumber ? 0 : 1);
}
}
//now looking up to calculated upper limit for non-empty line
for (int i = r.StartLine.LineNumber - 1; i >= upperLimit; i--)
{
ITextSnapshotLine line = r.StartPoint.Snapshot.GetLineFromLineNumber(i);
if (!string.IsNullOrWhiteSpace(line.GetText()))
{
//found such line, placing region start at its end
r.StartPoint = line.End;
return;
}
}
}
/// <summary>
/// Gets nested outlining regions for buffer
/// </summary>
protected void Outline()
{
ITextSnapshot snapshot = Buffer.CurrentSnapshot;
SnapshotParser parser = GetSnapshotParser(snapshot);
//parsing snapshot
TextRegion regionTree = Outliner.ParseBuffer(parser);
List <TextRegion> newRegions = GetRegionList(regionTree);
List <Span> oldSpans = Regions.ConvertAll(r => r.AsSnapshotSpan().TranslateTo(snapshot, SpanTrackingMode.EdgeExclusive).Span);
List <Span> newSpans = newRegions.ConvertAll(r => r.AsSnapshotSpan().Span);
NormalizedSpanCollection oldSpanCollection = new NormalizedSpanCollection(oldSpans);
NormalizedSpanCollection newSpanCollection = new NormalizedSpanCollection(newSpans);
//the changed regions are regions that appear in one set or the other, but not both.
NormalizedSpanCollection removed = NormalizedSpanCollection.Difference(oldSpanCollection, newSpanCollection);
int changeStart = int.MaxValue;
int changeEnd = -1;
if (removed.Count > 0)
{
changeStart = removed[0].Start;
changeEnd = removed[removed.Count - 1].End;
}
if (newSpans.Count > 0)
{
changeStart = Math.Min(changeStart, newSpans[0].Start);
changeEnd = Math.Max(changeEnd, newSpans[newSpans.Count - 1].End);
}
this.Snapshot = snapshot;
this.Regions = newRegions;
if (changeStart <= changeEnd && this.TagsChanged != null)
{
this.TagsChanged(this, new SnapshotSpanEventArgs(
new SnapshotSpan(this.Snapshot, Span.FromBounds(changeStart, changeEnd))));
}
FirstOutlining = false;
}
/// <summary>
/// parses buffer
/// </summary>
/// <param name="parser"></param>
/// <param name="parent">parent region or null</param>
/// <returns>a region with its children or null</returns>
protected virtual TextRegion ParseBuffer(SnapshotParser parser, TextRegion parent)
{
for (; !parser.AtEnd(); parser.MoveNext())
{
ProcessCurrentToken(parser);
TextRegion r = TryCreateRegion(parser);
if (r != null)
{
//found the start of the region
OnRegionFound(r);
r.Parent = parent;
parser.MoveNext();
if (!r.Complete)
{
//searching for child regions
while (ParseBuffer(parser, r) != null)
{
;
}
}
//adding to children or merging with last child
if (!TryMergeComments(parent, r))
{
parent.Children.Add(r);
ExtendStartPoint(r);
}
return(r);
}
//found parent's end - terminating parsing
if (TryComplete(parent, parser))
{
parser.MoveNext();
return(null);
}
}
return(null);
}
/// <summary>
/// converts region tree into flat list
/// </summary>
protected virtual List <TextRegion> GetRegionList(TextRegion tree)
{
List <TextRegion> res = new List <TextRegion>(tree.Children.Count);
foreach (TextRegion r in tree.Children)
{
if (r.Complete && r.StartLine.LineNumber != r.EndLine.LineNumber)
{
res.Add(r);
}
if (r.Children.Count != 0)
{
res.AddRange(GetRegionList(r));
}
}
//assigning tagger
foreach (TextRegion r in res)
{
r.Tagger = this;
}
return(res);
}
/// <summary>
/// parses buffer
/// </summary>
/// <param name="parser"></param>
/// <param name="parent">parent region or null</param>
/// <returns>a region with its children or null</returns>
protected virtual TextRegion ParseBuffer(SnapshotParser parser, TextRegion parent)
{
for (; !parser.AtEnd(); parser.MoveNext())
{
ProcessCurrentToken(parser);
TextRegion r = TryCreateRegion(parser);
if (r != null)
{
//found the start of the region
OnRegionFound(r);
r.Parent = parent;
parser.MoveNext();
if (!r.Complete)
{
//searching for child regions
while (ParseBuffer(parser, r) != null) ;
}
//adding to children or merging with last child
if (!TryMergeComments(parent, r))
{
parent.Children.Add(r);
ExtendStartPoint(r);
}
return r;
}
//found parent's end - terminating parsing
if (TryComplete(parent, parser))
{
parser.MoveNext();
return null;
}
}
return null;
}
/// <summary>
/// parser the text buffer
/// </summary>
/// <param name="parser">buffer parser</param>
/// <returns>text region tree</returns>
public TextRegion ParseBuffer(SnapshotParser parser)
{
TextRegion regionTree = new TextRegion();
while (ParseBuffer(parser, regionTree) != null);
return regionTree;
}
/// <summary> /// tries to close region /// </summary> /// <param name="parser">parser</param> /// <returns>whether region was closed</returns> protected abstract bool TryComplete(TextRegion r, SnapshotParser parser);
/// <summary> /// tries to merge sequential comments /// </summary> /// <returns>true, if merged. In this case newRegion is not added to Children</returns> protected abstract bool TryMergeComments(TextRegion r, TextRegion newRegion);
/// <summary>
/// Tries to move region start point up to get C#-like outlining
///
/// for (var k in obj)
/// { -- from here
///
/// for (var k in obj) -- to here
/// {
/// </summary>
private void ExtendStartPoint(TextRegion r)
{
//some are not extended
if (r.RegionType == TextRegionType.Region
|| r.RegionType == TextRegionType.Comment
|| !r.Complete
|| r.StartLine.LineNumber == r.EndLine.LineNumber
|| !string.IsNullOrWhiteSpace(r.TextBefore)) return;
//how much can we move region start
int upperLimit = 0;
if (r.Parent != null)
{
int childPosition = r.Parent.Children.IndexOf(r);
if (childPosition == -1)
childPosition = r.Parent.Children.Count;
if (childPosition == 0)
{
//this region is first child of its parent
//we can go until the parent's start
upperLimit = r.Parent.RegionType != TextRegionType.None ? r.Parent.StartLine.LineNumber + 1 : 0;
}
else
{
//there is previous child
//we can go until its end
TextRegion prevRegion = r.Parent.Children[childPosition - 1];
upperLimit = prevRegion.EndLine.LineNumber + (prevRegion.EndLine.LineNumber == prevRegion.StartLine.LineNumber ? 0 : 1);
}
}
//now looking up to calculated upper limit for non-empty line
for (int i = r.StartLine.LineNumber - 1; i >= upperLimit; i--)
{
ITextSnapshotLine line = r.StartPoint.Snapshot.GetLineFromLineNumber(i);
if (!string.IsNullOrWhiteSpace(line.GetText()))
{
//found such line, placing region start at its end
r.StartPoint = line.End;
return;
}
}
}
protected virtual void OnRegionFound(TextRegion r)
{
}
public CollapsedHintFormatter(TextRegion region)
{
Region = region;
}
/// <summary> /// tries to close region /// </summary> /// <param name="parser">parser</param> /// <returns>whether region was closed</returns> protected abstract bool TryComplete(TextRegion r, SnapshotParser parser);
/// <summary> /// tries to merge sequential comments /// </summary> /// <returns>true, if merged. In this case newRegion is not added to Children</returns> protected abstract bool TryMergeComments(TextRegion r, TextRegion newRegion);
protected virtual void OnRegionFound(TextRegion r)
{
}
public CollapsedHintFormatter(TextRegion region)
{
Region = region;
}