Files
Terminal.Gui/UnitTests/Text/AutocompleteTests.cs
BDisp 325180ae48 Fixes #2680. Make the TextView API more extensible. (#2682)
* Fixes #2680. Make the TextView API more extensible.

* Remove unnecessary using.

* Add GetLine method.

* Change RuneCell Attribute property to ColorScheme property.

* Add LoadRuneCells method and unit test.

* Add helper method to set all the Colors.ColorSchemes with the same attribute.

* Change RuneCell to class.

* Add IEquatable<RuneCell> interface.

* Fix unit test.

* Still fixing unit test.

* Fixes #2688. ReadOnly TextView's broken scrolling after version update.

* keyModifiers must be reset after key up was been processed.

* Trying fix server unit test error.

* Prevents throw an exception if RuneCell is null.

* Still trying fix this unit test.

* Cleaning code.

* Fix when the RuneCell is null.

* Fix throwing an exception if current column position is greater than the line length.

* Fixes #2689. Autocomplete doesn't popup after typing the first character.

* Fix Used on TextField.

* Always use the original ColorScheme if RuneCell.ColorScheme is null.

* Fix Used on TextView.

* Add RuneCellEventArgs and draw colors events.

* Add two more samples to the scenario.

* Fix a bug which was causing unit tests with ColorScheme fail.

* Fix a issue when WordWrap is true by always loading the old text.

* Improves debugging in RuneCell.

* WordWrap is now preserving the ColorScheme of the unwrapped lines.

* Simplifying unit test.

* Ensures the foreground and background colors are never the same if Used is false.

* Remove nullable from the parameter.

* Merge syntax highlighting of quotes and keywords together

* Add IdxRow property into the RuneCellEventArgs.

* Fix pos calculation on windows
(where newline in Text is \r\n not \n)

* Fix events not being cleared when toggling samples.

* Change Undo and Redo to a public method.

* Changes some methods names to be more explicit.

* Call OnContentsChanged on needed methods and fix some more bugs.

* Adds InheritsPreviousColorScheme to allow LoadRuneCells uses personalized color schemes.

* Serializes and deserializes RuneCell to a .rce extension file.

* Prevents throwing if column is bigger than the line.

* Avoids create a color attribute without one of the foreground or background values. In Linux using -1 throws an exception.

* Replace SetAllAttributesBasedOn method with a ColorScheme constructor.

* Move RuneCell string extensions to TextView.cs

* Reverted parameter name from cell to rune.

* Change Row to UnwrappedPosition which provide the real unwrapped text position within the Col.

* Add brackets to Undo and Redo methods.

* Replace all the LoadXXX with Load and rely on the param type to differentiate.

* Open a file inside a using.

* Proves that the events run twice for WordWrap disabled and the enabled.

* Remove GetColumns extension for RuneCell.

* Add braces to Undo an Redo.

* Change comment.

* Add braces.

* Delete remarks tag.

* Explaining used color and ProcessInheritsPreviousColorScheme.

* Fix comment.

* Created a RuneCellTests.cs file.

* Rename to StringToLinesOfRuneCells.

* Make ToRuneCells private.

---------

Co-authored-by: Thomas <tznind@dundee.ac.uk>
Co-authored-by: Thomas Nind <31306100+tznind@users.noreply.github.com>
2023-07-06 11:49:41 -06:00

255 lines
9.9 KiB
C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using Terminal.Gui;
using Xunit;
using Xunit.Abstractions;
namespace Terminal.Gui.TextTests {
public class AutocompleteTests {
readonly ITestOutputHelper output;
public AutocompleteTests (ITestOutputHelper output)
{
this.output = output;
}
[Fact]
public void Test_GenerateSuggestions_Simple ()
{
var ac = new TextViewAutocomplete ();
((SingleWordSuggestionGenerator)ac.SuggestionGenerator).AllSuggestions = new List<string> {
"fish",
"const",
"Cobble" };
var tv = new TextView ();
tv.InsertText ("co");
ac.HostControl = tv;
ac.GenerateSuggestions (
new AutocompleteContext (
TextModel.ToRuneCellList (tv.Text), 2));
Assert.Equal (2, ac.Suggestions.Count);
Assert.Equal ("const", ac.Suggestions [0].Title);
Assert.Equal ("Cobble", ac.Suggestions [1].Title);
}
[Fact]
[AutoInitShutdown]
public void TestSettingColorSchemeOnAutocomplete ()
{
var tv = new TextView ();
// to begin with we should be using the default menu color scheme
Assert.Same (Colors.Menu, tv.Autocomplete.ColorScheme);
// allocate a new custom scheme
tv.Autocomplete.ColorScheme = new ColorScheme () {
Normal = Application.Driver.MakeAttribute (Color.Black, Color.Blue),
Focus = Application.Driver.MakeAttribute (Color.Black, Color.Cyan),
};
// should be separate instance
Assert.NotSame (Colors.Menu, tv.Autocomplete.ColorScheme);
// with the values we set on it
Assert.Equal (Color.Black, tv.Autocomplete.ColorScheme.Normal.Foreground);
Assert.Equal (Color.Blue, tv.Autocomplete.ColorScheme.Normal.Background);
Assert.Equal (Color.Black, tv.Autocomplete.ColorScheme.Focus.Foreground);
Assert.Equal (Color.Cyan, tv.Autocomplete.ColorScheme.Focus.Background);
}
[Fact]
[AutoInitShutdown]
public void KeyBindings_Command ()
{
var tv = new TextView () {
Width = 10,
Height = 2,
Text = " Fortunately super feature."
};
var top = Application.Top;
top.Add (tv);
Application.Begin (top);
Assert.Equal (Point.Empty, tv.CursorPosition);
Assert.NotNull (tv.Autocomplete);
var g = (SingleWordSuggestionGenerator)tv.Autocomplete.SuggestionGenerator;
Assert.Empty (g.AllSuggestions);
g.AllSuggestions = Regex.Matches (tv.Text, "\\w+")
.Select (s => s.Value)
.Distinct ().ToList ();
Assert.Equal (3, g.AllSuggestions.Count);
Assert.Equal ("Fortunately", g.AllSuggestions [0]);
Assert.Equal ("super", g.AllSuggestions [1]);
Assert.Equal ("feature", g.AllSuggestions [^1]);
Assert.Equal (0, tv.Autocomplete.SelectedIdx);
Assert.Empty (tv.Autocomplete.Suggestions);
Assert.True (tv.ProcessKey (new KeyEvent (Key.F, new KeyModifiers ())));
top.Draw ();
Assert.Equal ($"F Fortunately super feature.", tv.Text);
Assert.Equal (new Point (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (0, tv.Autocomplete.SelectedIdx);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorDown, new KeyModifiers ())));
top.Draw ();
Assert.Equal ($"F Fortunately super feature.", tv.Text);
Assert.Equal (new Point (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (1, tv.Autocomplete.SelectedIdx);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorDown, new KeyModifiers ())));
top.Draw ();
Assert.Equal ($"F Fortunately super feature.", tv.Text);
Assert.Equal (new Point (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (0, tv.Autocomplete.SelectedIdx);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorUp, new KeyModifiers ())));
top.Draw ();
Assert.Equal ($"F Fortunately super feature.", tv.Text);
Assert.Equal (new Point (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (1, tv.Autocomplete.SelectedIdx);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorUp, new KeyModifiers ())));
top.Draw ();
Assert.Equal ($"F Fortunately super feature.", tv.Text);
Assert.Equal (new Point (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [0].Replacement);
Assert.Equal ("feature", tv.Autocomplete.Suggestions [^1].Replacement);
Assert.Equal (0, tv.Autocomplete.SelectedIdx);
Assert.Equal ("Fortunately", tv.Autocomplete.Suggestions [tv.Autocomplete.SelectedIdx].Replacement);
Assert.True (tv.Autocomplete.Visible);
top.Draw ();
Assert.True (tv.ProcessKey (new KeyEvent (tv.Autocomplete.CloseKey, new KeyModifiers ())));
Assert.Equal ($"F Fortunately super feature.", tv.Text);
Assert.Equal (new Point (1, 0), tv.CursorPosition);
Assert.Empty (tv.Autocomplete.Suggestions);
Assert.Equal (3, g.AllSuggestions.Count);
Assert.False (tv.Autocomplete.Visible);
tv.PositionCursor ();
Assert.True (tv.ProcessKey (new KeyEvent (tv.Autocomplete.Reopen, new KeyModifiers ())));
Assert.Equal ($"F Fortunately super feature.", tv.Text);
Assert.Equal (new Point (1, 0), tv.CursorPosition);
Assert.Equal (2, tv.Autocomplete.Suggestions.Count);
Assert.Equal (3, g.AllSuggestions.Count);
Assert.True (tv.ProcessKey (new KeyEvent (tv.Autocomplete.SelectionKey, new KeyModifiers ())));
tv.PositionCursor ();
Assert.Equal ($"Fortunately Fortunately super feature.", tv.Text);
Assert.Equal (new Point (11, 0), tv.CursorPosition);
Assert.Empty (tv.Autocomplete.Suggestions);
Assert.Equal (3, g.AllSuggestions.Count);
Assert.False (tv.Autocomplete.Visible);
}
[Fact, AutoInitShutdown]
public void CursorLeft_CursorRight_Mouse_Button_Pressed_Does_Not_Show_Popup ()
{
var tv = new TextView () {
Width = 50,
Height = 5,
Text = "This a long line and against TextView."
};
var g = (SingleWordSuggestionGenerator)tv.Autocomplete.SuggestionGenerator;
g.AllSuggestions = Regex.Matches (tv.Text, "\\w+")
.Select (s => s.Value)
.Distinct ().ToList ();
var top = Application.Top;
top.Add (tv);
Application.Begin (top);
for (int i = 0; i < 7; i++) {
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Application.Refresh ();
if (i < 4 || i > 5) {
TestHelpers.AssertDriverContentsWithFrameAre (@"
This a long line and against TextView.", output);
} else {
TestHelpers.AssertDriverContentsWithFrameAre (@"
This a long line and against TextView.
and
against ", output);
}
}
Assert.True (tv.MouseEvent (new MouseEvent () {
X = 6,
Y = 0,
Flags = MouseFlags.Button1Pressed
}));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This a long line and against TextView.
and
against ", output);
Assert.True (tv.ProcessKey (new KeyEvent (Key.g, new KeyModifiers ())));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This ag long line and against TextView.
against ", output);
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorLeft, new KeyModifiers ())));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This ag long line and against TextView.
against ", output);
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorLeft, new KeyModifiers ())));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This ag long line and against TextView.
against ", output);
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorLeft, new KeyModifiers ())));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This ag long line and against TextView.", output);
for (int i = 0; i < 3; i++) {
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This ag long line and against TextView.
against ", output);
}
Assert.True (tv.ProcessKey (new KeyEvent (Key.Backspace, new KeyModifiers ())));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This a long line and against TextView.
and
against ", output);
Assert.True (tv.ProcessKey (new KeyEvent (Key.n, new KeyModifiers ())));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This an long line and against TextView.
and ", output);
Assert.True (tv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This an long line and against TextView.", output);
}
}
}