Skip to content

Reduce allocations while enumerating Speller suggestions and improve performance #9439

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

Merged
merged 4 commits into from
Oct 1, 2024
Merged

Reduce allocations while enumerating Speller suggestions and improve performance #9439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f3efc6
replace arraylist with list<string>, remove unnecessary casts and ite…
h3xds1nz Jul 20, 2024
844b414
simplify GetSuggestionsForError, use inline var declarations
h3xds1nz Jul 22, 2024
2c55fb2
adjust the initial capacity to the typical number of suggestions
h3xds1nz Jul 22, 2024
adcd286
properly evaluate whether we can spell-check
h3xds1nz Sep 9, 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
30 changes: 9 additions & 21 deletions src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Documents/Speller.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,36 +177,24 @@ internal ITextPointer GetNextSpellingErrorPosition(ITextPointer position, Logica
// for an error range.
// This method actually runs the speller on the specified text,
// re-evaluating the error from scratch.
internal IList GetSuggestionsForError(SpellingError error)
internal List<string> GetSuggestionsForError(SpellingError error)
{
ITextPointer contextStart;
ITextPointer contextEnd;
ITextPointer contentStart;
ITextPointer contentEnd;
TextMap textMap;
ArrayList suggestions;

suggestions = new ArrayList(1);

//
// IMPORTANT!!
//
// This logic here must match ScanRange, or else we might not
// calculate the exact same error. Keep the two methods in sync!
//

XmlLanguage language;
CultureInfo culture = GetCurrentCultureAndLanguage(error.Start, out language);
if (culture == null || !_spellerInterop.CanSpellCheck(culture))
{
// Return an empty list.
}
else
List<string> suggestions = new(4);
CultureInfo culture = GetCurrentCultureAndLanguage(error.Start, out XmlLanguage language);

if (culture is not null && _spellerInterop.CanSpellCheck(culture))
{
ExpandToWordBreakAndContext(error.Start, LogicalDirection.Backward, language, out contentStart, out contextStart);
ExpandToWordBreakAndContext(error.End, LogicalDirection.Forward, language, out contentEnd, out contextEnd);
ExpandToWordBreakAndContext(error.Start, LogicalDirection.Backward, language, out ITextPointer contentStart, out ITextPointer contextStart);
ExpandToWordBreakAndContext(error.End, LogicalDirection.Forward, language, out ITextPointer contentEnd, out ITextPointer contextEnd);

textMap = new TextMap(contextStart, contextEnd, contentStart, contentEnd);
TextMap textMap = new(contextStart, contextEnd, contentStart, contentEnd);

SetCulture(culture);

Expand Down Expand Up @@ -915,7 +903,7 @@ private bool ScanErrorTextSegment(SpellerInteropBase.ISpellerSegment textSegment
{
if (textSegment.SubSegments.Count == 0)
{
ArrayList suggestions = (ArrayList)data.Data;
List<string> suggestions = (List<string>)data.Data;
if(textSegment.Suggestions.Count > 0)
{
foreach(string suggestion in textSegment.Suggestions)
Expand Down
10 changes: 1 addition & 9 deletions src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Documents/SpellerError.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,7 @@ public void IgnoreAll()
/// </remarks>
public IEnumerable<string> Suggestions
{
get
{
IList suggestions = _speller.GetSuggestionsForError(this);

for (int i=0; i<suggestions.Count; i++)
{
yield return (string)suggestions[i];
}
}
get => _speller.GetSuggestionsForError(this);
}

#endregion Public Properties
Expand Down