Browse Source
DocumentHighlighter now only is only responsible for maintaining the highlighting state (span stacks at line boundaries).pull/32/merge
5 changed files with 354 additions and 242 deletions
@ -0,0 +1,303 @@ |
|||||||
|
// Copyright (c) AlphaSierraPapa for the SharpDevelop Team (for details please see \doc\copyright.txt)
|
||||||
|
// This code is distributed under the GNU LGPL (for details please see \doc\license.txt)
|
||||||
|
|
||||||
|
using System; |
||||||
|
using System.Collections.Generic; |
||||||
|
using System.Diagnostics; |
||||||
|
using System.Linq; |
||||||
|
using System.Text.RegularExpressions; |
||||||
|
using ICSharpCode.NRefactory.Editor; |
||||||
|
using ICSharpCode.AvalonEdit.Utils; |
||||||
|
using SpanStack = ICSharpCode.NRefactory.Utils.ImmutableStack<ICSharpCode.AvalonEdit.Highlighting.HighlightingSpan>; |
||||||
|
|
||||||
|
namespace ICSharpCode.AvalonEdit.Highlighting |
||||||
|
{ |
||||||
|
/// <summary>
|
||||||
|
/// Regex-based highlighting engine.
|
||||||
|
/// </summary>
|
||||||
|
public class HighlightingEngine |
||||||
|
{ |
||||||
|
readonly HighlightingRuleSet mainRuleSet; |
||||||
|
SpanStack spanStack = SpanStack.Empty; |
||||||
|
|
||||||
|
public HighlightingEngine(HighlightingRuleSet mainRuleSet) |
||||||
|
{ |
||||||
|
if (mainRuleSet == null) |
||||||
|
throw new ArgumentNullException("mainRuleSet"); |
||||||
|
this.mainRuleSet = mainRuleSet; |
||||||
|
} |
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Gets/sets the current span stack.
|
||||||
|
/// </summary>
|
||||||
|
public SpanStack CurrentSpanStack { |
||||||
|
get { return spanStack; } |
||||||
|
set { |
||||||
|
spanStack = value ?? SpanStack.Empty; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
#region Highlighting Engine
|
||||||
|
|
||||||
|
// local variables from HighlightLineInternal (are member because they are accessed by HighlighLine helper methods)
|
||||||
|
string lineText; |
||||||
|
int lineStartOffset; |
||||||
|
int position; |
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// the HighlightedLine where highlighting output is being written to.
|
||||||
|
/// if this variable is null, nothing is highlighted and only the span state is updated
|
||||||
|
/// </summary>
|
||||||
|
HighlightedLine highlightedLine; |
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Highlights the specified line in the specified document.
|
||||||
|
///
|
||||||
|
/// Before calling this method, <see cref="CurrentSpanStack"/> must be set to the proper
|
||||||
|
/// state for the beginning of this line. After highlighting has completed,
|
||||||
|
/// <see cref="CurrentSpanStack"/> will be updated to represent the state after the line.
|
||||||
|
/// </summary>
|
||||||
|
public HighlightedLine HighlightLine(IDocument document, IDocumentLine line) |
||||||
|
{ |
||||||
|
this.lineStartOffset = line.Offset; |
||||||
|
this.lineText = document.GetText(line); |
||||||
|
try { |
||||||
|
this.highlightedLine = new HighlightedLine(document, line); |
||||||
|
HighlightLineInternal(); |
||||||
|
return this.highlightedLine; |
||||||
|
} finally { |
||||||
|
this.highlightedLine = null; |
||||||
|
this.lineText = null; |
||||||
|
this.lineStartOffset = 0; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Updates <see cref="CurrentSpanStack"/> for the specified line in the specified document.
|
||||||
|
///
|
||||||
|
/// Before calling this method, <see cref="CurrentSpanStack"/> must be set to the proper
|
||||||
|
/// state for the beginning of this line. After highlighting has completed,
|
||||||
|
/// <see cref="CurrentSpanStack"/> will be updated to represent the state after the line.
|
||||||
|
/// </summary>
|
||||||
|
public void ScanLine(IDocument document, IDocumentLine line) |
||||||
|
{ |
||||||
|
//this.lineStartOffset = line.Offset; not necessary for scanning
|
||||||
|
this.lineText = document.GetText(line); |
||||||
|
try { |
||||||
|
Debug.Assert(highlightedLine == null); |
||||||
|
HighlightLineInternal(); |
||||||
|
} finally { |
||||||
|
this.lineText = null; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void HighlightLineInternal() |
||||||
|
{ |
||||||
|
position = 0; |
||||||
|
ResetColorStack(); |
||||||
|
HighlightingRuleSet currentRuleSet = this.CurrentRuleSet; |
||||||
|
Stack<Match[]> storedMatchArrays = new Stack<Match[]>(); |
||||||
|
Match[] matches = AllocateMatchArray(currentRuleSet.Spans.Count); |
||||||
|
Match endSpanMatch = null; |
||||||
|
|
||||||
|
while (true) { |
||||||
|
for (int i = 0; i < matches.Length; i++) { |
||||||
|
if (matches[i] == null || (matches[i].Success && matches[i].Index < position)) |
||||||
|
matches[i] = currentRuleSet.Spans[i].StartExpression.Match(lineText, position); |
||||||
|
} |
||||||
|
if (endSpanMatch == null && !spanStack.IsEmpty) |
||||||
|
endSpanMatch = spanStack.Peek().EndExpression.Match(lineText, position); |
||||||
|
|
||||||
|
Match firstMatch = Minimum(matches, endSpanMatch); |
||||||
|
if (firstMatch == null) |
||||||
|
break; |
||||||
|
|
||||||
|
HighlightNonSpans(firstMatch.Index); |
||||||
|
|
||||||
|
Debug.Assert(position == firstMatch.Index); |
||||||
|
|
||||||
|
if (firstMatch == endSpanMatch) { |
||||||
|
HighlightingSpan poppedSpan = spanStack.Peek(); |
||||||
|
if (!poppedSpan.SpanColorIncludesEnd) |
||||||
|
PopColor(); // pop SpanColor
|
||||||
|
PushColor(poppedSpan.EndColor); |
||||||
|
position = firstMatch.Index + firstMatch.Length; |
||||||
|
PopColor(); // pop EndColor
|
||||||
|
if (poppedSpan.SpanColorIncludesEnd) |
||||||
|
PopColor(); // pop SpanColor
|
||||||
|
spanStack = spanStack.Pop(); |
||||||
|
currentRuleSet = this.CurrentRuleSet; |
||||||
|
//FreeMatchArray(matches);
|
||||||
|
if (storedMatchArrays.Count > 0) { |
||||||
|
matches = storedMatchArrays.Pop(); |
||||||
|
int index = currentRuleSet.Spans.IndexOf(poppedSpan); |
||||||
|
Debug.Assert(index >= 0 && index < matches.Length); |
||||||
|
if (matches[index].Index == position) { |
||||||
|
throw new InvalidOperationException( |
||||||
|
"A highlighting span matched 0 characters, which would cause an endless loop.\n" + |
||||||
|
"Change the highlighting definition so that either the start or the end regex matches at least one character.\n" + |
||||||
|
"Start regex: " + poppedSpan.StartExpression + "\n" + |
||||||
|
"End regex: " + poppedSpan.EndExpression); |
||||||
|
} |
||||||
|
} else { |
||||||
|
matches = AllocateMatchArray(currentRuleSet.Spans.Count); |
||||||
|
} |
||||||
|
} else { |
||||||
|
int index = Array.IndexOf(matches, firstMatch); |
||||||
|
Debug.Assert(index >= 0); |
||||||
|
HighlightingSpan newSpan = currentRuleSet.Spans[index]; |
||||||
|
spanStack = spanStack.Push(newSpan); |
||||||
|
currentRuleSet = this.CurrentRuleSet; |
||||||
|
storedMatchArrays.Push(matches); |
||||||
|
matches = AllocateMatchArray(currentRuleSet.Spans.Count); |
||||||
|
if (newSpan.SpanColorIncludesStart) |
||||||
|
PushColor(newSpan.SpanColor); |
||||||
|
PushColor(newSpan.StartColor); |
||||||
|
position = firstMatch.Index + firstMatch.Length; |
||||||
|
PopColor(); |
||||||
|
if (!newSpan.SpanColorIncludesStart) |
||||||
|
PushColor(newSpan.SpanColor); |
||||||
|
} |
||||||
|
endSpanMatch = null; |
||||||
|
} |
||||||
|
HighlightNonSpans(lineText.Length); |
||||||
|
|
||||||
|
PopAllColors(); |
||||||
|
} |
||||||
|
|
||||||
|
void HighlightNonSpans(int until) |
||||||
|
{ |
||||||
|
Debug.Assert(position <= until); |
||||||
|
if (position == until) |
||||||
|
return; |
||||||
|
if (highlightedLine != null) { |
||||||
|
IList<HighlightingRule> rules = CurrentRuleSet.Rules; |
||||||
|
Match[] matches = AllocateMatchArray(rules.Count); |
||||||
|
while (true) { |
||||||
|
for (int i = 0; i < matches.Length; i++) { |
||||||
|
if (matches[i] == null || (matches[i].Success && matches[i].Index < position)) |
||||||
|
matches[i] = rules[i].Regex.Match(lineText, position, until - position); |
||||||
|
} |
||||||
|
Match firstMatch = Minimum(matches, null); |
||||||
|
if (firstMatch == null) |
||||||
|
break; |
||||||
|
|
||||||
|
position = firstMatch.Index; |
||||||
|
int ruleIndex = Array.IndexOf(matches, firstMatch); |
||||||
|
if (firstMatch.Length == 0) { |
||||||
|
throw new InvalidOperationException( |
||||||
|
"A highlighting rule matched 0 characters, which would cause an endless loop.\n" + |
||||||
|
"Change the highlighting definition so that the rule matches at least one character.\n" + |
||||||
|
"Regex: " + rules[ruleIndex].Regex); |
||||||
|
} |
||||||
|
PushColor(rules[ruleIndex].Color); |
||||||
|
position = firstMatch.Index + firstMatch.Length; |
||||||
|
PopColor(); |
||||||
|
} |
||||||
|
//FreeMatchArray(matches);
|
||||||
|
} |
||||||
|
position = until; |
||||||
|
} |
||||||
|
|
||||||
|
static readonly HighlightingRuleSet emptyRuleSet = new HighlightingRuleSet() { Name = "EmptyRuleSet" }; |
||||||
|
|
||||||
|
HighlightingRuleSet CurrentRuleSet { |
||||||
|
get { |
||||||
|
if (spanStack.IsEmpty) |
||||||
|
return mainRuleSet; |
||||||
|
else |
||||||
|
return spanStack.Peek().RuleSet ?? emptyRuleSet; |
||||||
|
} |
||||||
|
} |
||||||
|
#endregion
|
||||||
|
|
||||||
|
#region Color Stack Management
|
||||||
|
Stack<HighlightedSection> highlightedSectionStack; |
||||||
|
HighlightedSection lastPoppedSection; |
||||||
|
|
||||||
|
void ResetColorStack() |
||||||
|
{ |
||||||
|
Debug.Assert(position == 0); |
||||||
|
lastPoppedSection = null; |
||||||
|
if (highlightedLine == null) { |
||||||
|
highlightedSectionStack = null; |
||||||
|
} else { |
||||||
|
highlightedSectionStack = new Stack<HighlightedSection>(); |
||||||
|
foreach (HighlightingSpan span in spanStack.Reverse()) { |
||||||
|
PushColor(span.SpanColor); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void PushColor(HighlightingColor color) |
||||||
|
{ |
||||||
|
if (highlightedLine == null) |
||||||
|
return; |
||||||
|
if (color == null) { |
||||||
|
highlightedSectionStack.Push(null); |
||||||
|
} else if (lastPoppedSection != null && lastPoppedSection.Color == color |
||||||
|
&& lastPoppedSection.Offset + lastPoppedSection.Length == position + lineStartOffset) |
||||||
|
{ |
||||||
|
highlightedSectionStack.Push(lastPoppedSection); |
||||||
|
lastPoppedSection = null; |
||||||
|
} else { |
||||||
|
HighlightedSection hs = new HighlightedSection { |
||||||
|
Offset = position + lineStartOffset, |
||||||
|
Color = color |
||||||
|
}; |
||||||
|
highlightedLine.Sections.Add(hs); |
||||||
|
highlightedSectionStack.Push(hs); |
||||||
|
lastPoppedSection = null; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void PopColor() |
||||||
|
{ |
||||||
|
if (highlightedLine == null) |
||||||
|
return; |
||||||
|
HighlightedSection s = highlightedSectionStack.Pop(); |
||||||
|
if (s != null) { |
||||||
|
s.Length = (position + lineStartOffset) - s.Offset; |
||||||
|
if (s.Length == 0) |
||||||
|
highlightedLine.Sections.Remove(s); |
||||||
|
else |
||||||
|
lastPoppedSection = s; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void PopAllColors() |
||||||
|
{ |
||||||
|
if (highlightedSectionStack != null) { |
||||||
|
while (highlightedSectionStack.Count > 0) |
||||||
|
PopColor(); |
||||||
|
} |
||||||
|
} |
||||||
|
#endregion
|
||||||
|
|
||||||
|
#region Match helpers
|
||||||
|
/// <summary>
|
||||||
|
/// Returns the first match from the array or endSpanMatch.
|
||||||
|
/// </summary>
|
||||||
|
static Match Minimum(Match[] arr, Match endSpanMatch) |
||||||
|
{ |
||||||
|
Match min = null; |
||||||
|
foreach (Match v in arr) { |
||||||
|
if (v.Success && (min == null || v.Index < min.Index)) |
||||||
|
min = v; |
||||||
|
} |
||||||
|
if (endSpanMatch != null && endSpanMatch.Success && (min == null || endSpanMatch.Index < min.Index)) |
||||||
|
return endSpanMatch; |
||||||
|
else |
||||||
|
return min; |
||||||
|
} |
||||||
|
|
||||||
|
static Match[] AllocateMatchArray(int count) |
||||||
|
{ |
||||||
|
if (count == 0) |
||||||
|
return Empty<Match>.Array; |
||||||
|
else |
||||||
|
return new Match[count]; |
||||||
|
} |
||||||
|
#endregion
|
||||||
|
} |
||||||
|
} |
||||||
Loading…
Reference in new issue