Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added configurable delay before executing the search which improves user experience with large documents #247

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Added configurable delay before executing the search which improves user experience with large documents #247

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
82afb0d
Added configurable delay before executing the search which improves u…
Oct 14, 2020
d82a3d7
Merge branch 'master' into master
dbCF Sep 29, 2023
a1c9299
Added missing XML documentation
Sep 29, 2023
51e377f
Added event which triggers when the search wraps the end/start of the…
Nov 29, 2024
32d2cf6
Merge branch 'icsharpcode:master' into master
dbCF Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 97 additions & 27 deletions ICSharpCode.AvalonEdit/Search/SearchPanel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Threading;

using ICSharpCode.AvalonEdit.Document;
using ICSharpCode.AvalonEdit.Editing;
Expand All @@ -36,6 +37,16 @@ namespace ICSharpCode.AvalonEdit.Search
/// </summary>
public class SearchPanel : Control
{
/// <summary>
/// Specifies the time to wait till the entered text is searched for
/// </summary>
public static int DelayBeforeSearch { get; set; } = 250;

/// <summary>
/// Event that occurs if the search wrapped the end or beginning of the file
/// </summary>
public static event EventHandler SearchWrapped;

TextArea textArea;
SearchInputHandler handler;
TextDocument currentDocument;
Expand All @@ -44,6 +55,10 @@ public class SearchPanel : Control
Popup dropdownPopup;
SearchPanelAdorner adorner;

DispatcherTimer typingTimer;
bool lastChangeSelection;


#region DependencyProperties
/// <summary>
/// Dependency property for <see cref="UseRegex"/>.
Expand All @@ -55,7 +70,8 @@ public class SearchPanel : Control
/// <summary>
/// Gets/sets whether the search pattern should be interpreted as regular expression.
/// </summary>
public bool UseRegex {
public bool UseRegex
{
get { return (bool)GetValue(UseRegexProperty); }
set { SetValue(UseRegexProperty, value); }
}
Expand All @@ -70,7 +86,8 @@ public bool UseRegex {
/// <summary>
/// Gets/sets whether the search pattern should be interpreted case-sensitive.
/// </summary>
public bool MatchCase {
public bool MatchCase
{
get { return (bool)GetValue(MatchCaseProperty); }
set { SetValue(MatchCaseProperty, value); }
}
Expand All @@ -85,7 +102,8 @@ public bool MatchCase {
/// <summary>
/// Gets/sets whether the search pattern should only match whole words.
/// </summary>
public bool WholeWords {
public bool WholeWords
{
get { return (bool)GetValue(WholeWordsProperty); }
set { SetValue(WholeWordsProperty, value); }
}
Expand All @@ -100,7 +118,8 @@ public bool WholeWords {
/// <summary>
/// Gets/sets the search pattern.
/// </summary>
public string SearchPattern {
public string SearchPattern
{
get { return (string)GetValue(SearchPatternProperty); }
set { SetValue(SearchPatternProperty, value); }
}
Expand All @@ -115,7 +134,8 @@ public string SearchPattern {
/// <summary>
/// Gets/sets the Brush used for marking search results in the TextView.
/// </summary>
public Brush MarkerBrush {
public Brush MarkerBrush
{
get { return (Brush)GetValue(MarkerBrushProperty); }
set { SetValue(MarkerBrushProperty, value); }
}
Expand Down Expand Up @@ -181,7 +201,8 @@ private static void MarkerCornerRadiusChangedCallback(DependencyObject d, Depend
/// <summary>
/// Gets/sets the localization for the SearchPanel.
/// </summary>
public Localization Localization {
public Localization Localization
{
get { return (Localization)GetValue(LocalizationProperty); }
set { SetValue(LocalizationProperty, value); }
}
Expand All @@ -197,7 +218,8 @@ static SearchPanel()
static void SearchPatternChangedCallback(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
SearchPanel panel = d as SearchPanel;
if (panel != null) {
if (panel != null)
{
panel.ValidateSearchText();
panel.UpdateSearch();
}
Expand Down Expand Up @@ -291,7 +313,8 @@ void textArea_DocumentChanged(object sender, EventArgs e)
if (currentDocument != null)
currentDocument.TextChanged -= textArea_Document_TextChanged;
currentDocument = textArea.Document;
if (currentDocument != null) {
if (currentDocument != null)
{
currentDocument.TextChanged += textArea_Document_TextChanged;
DoSearch(false);
}
Expand All @@ -318,13 +341,16 @@ void ValidateSearchText()

var be = searchTextBox.GetBindingExpression(TextBox.TextProperty);

try {
try
{
if (be != null)
Validation.ClearInvalid(be);

UpdateSearch();

} catch (SearchPatternException ex) {
}
catch (SearchPatternException ex)
{
var ve = new ValidationError(be.ParentBinding.ValidationRules[0], be, ex.Message, ex);
Validation.MarkInvalid(be, ve);
}
Expand All @@ -349,8 +375,10 @@ public void FindNext()
SearchResult result = renderer.CurrentResults.FindFirstSegmentWithStartAfter(textArea.Caret.Offset + 1);
if (result == null)
result = renderer.CurrentResults.FirstSegment;
if (result != null) {
SelectResult(result);
if (result != null)
{
var s = Selection.Create(textArea, result.StartOffset, result.EndOffset);
SelectResult(result, textArea.Caret.Line >= s.StartPosition.Line);
}
}

Expand All @@ -364,8 +392,10 @@ public void FindPrevious()
result = renderer.CurrentResults.GetPreviousSegment(result);
if (result == null)
result = renderer.CurrentResults.LastSegment;
if (result != null) {
SelectResult(result);
if (result != null)
{
var s = Selection.Create(textArea, result.StartOffset, result.EndOffset);
SelectResult(result, textArea.Caret.Line <= s.StartPosition.Line);
}
}

Expand All @@ -375,52 +405,90 @@ void DoSearch(bool changeSelection)
{
if (IsClosed)
return;

lastChangeSelection = changeSelection;
if (typingTimer == null)
{
typingTimer = new DispatcherTimer
{
Interval = TimeSpan.FromMilliseconds(DelayBeforeSearch)
};

typingTimer.Tick += handleTypingTimerTimeout;
}
typingTimer.Stop();
typingTimer.Start();
}

private void handleTypingTimerTimeout(object sender, EventArgs e)
{
var timer = sender as DispatcherTimer; // WPF
if (timer == null)
{
return;
}

var changeSelection = lastChangeSelection;
renderer.CurrentResults.Clear();

if (!string.IsNullOrEmpty(SearchPattern)) {
if (!string.IsNullOrEmpty(SearchPattern))
{
int offset = textArea.Caret.Offset;
if (changeSelection) {
if (changeSelection)
{
textArea.ClearSelection();
}
// We cast from ISearchResult to SearchResult; this is safe because we always use the built-in strategy
foreach (SearchResult result in strategy.FindAll(textArea.Document, 0, textArea.Document.TextLength)) {
if (changeSelection && result.StartOffset >= offset) {
SelectResult(result);
foreach (SearchResult result in strategy.FindAll(textArea.Document, 0, textArea.Document.TextLength))
{
if (changeSelection && result.StartOffset >= offset)
{
SelectResult(result, false);
changeSelection = false;
}
renderer.CurrentResults.Add(result);
}
if (!renderer.CurrentResults.Any()) {
if (!renderer.CurrentResults.Any())
{
messageView.IsOpen = true;
messageView.Content = Localization.NoMatchesFoundText;
messageView.PlacementTarget = searchTextBox;
} else
}
else
messageView.IsOpen = false;
}
textArea.TextView.InvalidateLayer(KnownLayer.Selection);

timer.Stop();
}

void SelectResult(SearchResult result)
void SelectResult(SearchResult result, bool searchWrapped)
{
textArea.Caret.Offset = result.StartOffset;
textArea.Selection = Selection.Create(textArea, result.StartOffset, result.EndOffset);
textArea.Caret.BringCaretToView();
// show caret even if the editor does not have the Keyboard Focus
textArea.Caret.Show();
if (searchWrapped) {
SearchWrapped?.Invoke(this, EventArgs.Empty);
}
}

void SearchLayerKeyDown(object sender, KeyEventArgs e)
{
switch (e.Key) {
switch (e.Key)
{
case Key.Enter:
e.Handled = true;
if ((Keyboard.Modifiers & ModifierKeys.Shift) == ModifierKeys.Shift)
FindPrevious();
else
FindNext();
if (searchTextBox != null) {
if (searchTextBox != null)
{
var error = Validation.GetErrors(searchTextBox).FirstOrDefault();
if (error != null) {
if (error != null)
{
messageView.Content = Localization.ErrorText + " " + error.ErrorContent;
messageView.PlacementTarget = searchTextBox;
messageView.IsOpen = true;
Expand Down Expand Up @@ -485,7 +553,8 @@ public void Open()
/// </summary>
protected virtual void OnSearchOptionsChanged(SearchOptionsChangedEventArgs e)
{
if (SearchOptionsChanged != null) {
if (SearchOptionsChanged != null)
{
SearchOptionsChanged(this, e);
}
}
Expand Down Expand Up @@ -539,7 +608,8 @@ public SearchPanelAdorner(TextArea textArea, SearchPanel panel)
AddVisualChild(panel);
}

protected override int VisualChildrenCount {
protected override int VisualChildrenCount
{
get { return 1; }
}

Expand Down
Loading