Files
Terminal.Gui/UnitTests/Views/RuneCellTests.cs
Tig dcb3b359ad Fixes #2926 - Refactor KeyEvent and KeyEventEventArgs to simplify (#2927)
* Adds basic MainLoop unit tests

* Remove WinChange action from Curses

* Remove WinChange action from Curses

* Remove ProcessInput action from Windows MainLoop

* Simplified MainLoop/ConsoleDriver by making MainLoop internal and moving impt fns to Application

* Modernized Terminal resize events

* Modernized Terminal resize events

* Removed un used property

* for _isWindowsTerminal devenv->wininit; not sure what changed

* Modernized mouse/keyboard events (Action->EventHandler)

* Updated OnMouseEvent API docs

* Using WT_SESSION to detect WT

* removes hacky GetParentProcess

* Updates to fix #2634 (clear last line)

* removes hacky GetParentProcess2

* Addressed mac resize issue

* Addressed mac resize issue

* Removes ConsoleDriver.PrepareToRun, has Init return MainLoop

* Removes unneeded Attribute methods

* Removed GetProcesssName

* Removed GetProcesssName

* Refactored KeyEvent and KeyEventEventArgs into a single class

* Revert "Refactored KeyEvent and KeyEventEventArgs into a single class"

This reverts commit 88a00658db.

* Fixed key repeat issue; reverted stupidity on 1049/1047 confusion

* Updated CSI API Docs

* merge

* Rearranged Event.cs to Keyboard.cs and Mouse.cs

* Renamed KeyEventEventArgs KeyEventArgs

* temp renamed KeyEvent OldKeyEvent

* Merged KeyEvent into KeyEventArgs

* Renamed Application.ProcessKey members

* Renamed Application.ProcessKey members

* Renamed Application.ProcessKey members

* Added Responder.KeyPressed

* Removed unused references

* Fixed arg naming

* InvokeKeybindings->InvokeKeyBindings

* InvokeKeybindings->InvokeKeyBindings

* Fixed unit tests fail

* More progress on refactoring key input; still broken and probably wrong

* Moved OnKeyPressed out of Responder and made ProcessKeyPrssed non-virtual

* Updated API docs

* Moved key handling from Responder to View

* Updated API docs

* Updated HotKey API docs

* Updated shortcut API docs

* Fixed responder unit tests

* Removed Shortcut from View as it is not used

* Removed unneeded OnHotKey override from Button

* Fixed BackTab logic

* Button now uses Key Bindings exclusively

* Button now uses Key Bindings exclusively

* Updated keyboard.md docs

* Fixed unit tests to account for Toplevel handling default button

* Added View.InvokeCommand API

* Modernized RadioGroup

* Removed ColdKey

* Modernized (partially) StatusBar

* Worked around FileDialog issue with Ctrl-F

* Fixed driver unit test; view must be focused to reciev key pressed

* Application code cleanup

* Start on updaing menu

* Menu now mostly works

* Menu Select refinement

* Fixed known menu bugs!

* Enabled HotKey to cause focus- experimental

* Fixes #3022 & adds unit test to prove it

* Actually Fixes #3022 & adds unit test to prove it

* Working through hotkey issues

* Misc fixes

* removed hot/cold key stuff from Keys scenario

* Fixed scenarios

* Simplified shortcut string handling

* Modernized Checkbox

* Modernized TileView

* Updated API docs

* Updated API docs

* attempting to publish v2 docs

* Revert "attempting to publish v2 docs"

This reverts commit 59dcec111b.

* Playing with api docs

* Removed Key.BackTab

* Removed Caps/Scroll/Numlock

* Partial removal of keymodifiers - unit tests pass

* Partial removal of keymodifiers - broke netdriver somewhere

* WindowsDriver & added KeyEventArgsTests

* Fixing menu shortcut/hotkeys - broke Menu.cs into separate files

* Fixed MenuBar!

* Finished modernizing Menu/MenuBar

* Removed Key.a-z. Broke lots of stuff

* checkout@v4

* progress on key mapping and formatting

* VK tests are still failing

* Fixed some unit tests

* Added Hotkey and Keybinding unit tests

* fixed unit test

* All unit tests pass again...

* Fixed broken unit tests

* KeyEventArgs.KeyValue -> AsRune

* Fixed bugs. Still some broken

* Added KeyEventArgs.IsAlpha. Added KeyEventArgs.cast ops. Fixed bugs. Unit tests pass

* Fixed WindowsDriver

* Oops.

* Refactoring based on bdisp's help. Not complete!

* removed calling into subviews from OnKeyBindings

* removed calling into subviews from OnKeyBindings

* Improved View KeyEvent unit tests

* More hotkey unit tests

* BIg change - Got rid of KeyPress w/in Application/Drivers

* Unit tests now pass again

* Refreshed API docs

* Better HotKey logic. More progress. Getting close.

* Fixed handling of shifted chars like ö

* Minor code cleanup

* Minor code cleanup2

* Why is build Action failing?

* Why is build Action failing??

* upgraded to .net8 to try to fix weird CI/CD build errors

* upgraded to .net8 to try to fix weird CI/CD build errors2

* Disabling TextViewTests to diagnose build errors

* reenable TextViewTests to diagnose build errors

* Arrrrrrg

* Merged v2_develop

* Fixed uppercase accented keys in WindowsDriver

* Fixed key binding api docs

* Experimental impl of CommandScope.SubViews for MenuBar

* Removed dead code from application.cs

* Removed dead code from application.cs

* Removed dead code from ConsoleDriver.cs

* Cleaned up some key binding stuff

* Disabled Alt to activate menu for now

* Updated label commands

* Fixed menu bugs. Upgraded menu unit tests

* Fixed unit tests

* Working on NetDriver

* fixed netdriver

* Fixed issues called out by @bdisp CR

* fixed CursesDriver

* added todo to netdriver

* Cherry picked treeview test fix 1b415e5

* Fix NetDriver.

* CommandScope->KeyBindingScope

* Address some tznind feedback

* Refactored KeyBindings big time!

* Added key consts to KeyEventArgs and renamed Key to ConsoleDriverKey

* Fixed some API docs

* Moved ConsoleDriverKey to ConsoleDriver.cs

* Renamed Key->ConsoleDriverKey

* Renamed Key->ConsoleDriverKey

* Renamed Key->ConsoleDriverKey

* renamed file I forgot to rename before

* Updated name and API docs of KeyEventArgs.isAlpha

* Fixed issues with OnKeyUp not doing the right thing.

* Fixed MainLoop.Running never being used

* Fixed MainLoop.Running never being used - unit tests

* Claned up BUGBUG comments

* Disabled a unit test to see why ci/cd tests are failing

* Removed defunct commented code

* Removed more defunct commented code

* Re-eanbled unit test; jsut removing one test case...

* Disabled more...

* Renambed Global->Applicaton and updated scope API docs

* Disabled more unit tests...

* Removed dead code

* Disabled more unit tests...2

* Disabled more unit tests...3

* Renambed Global->Applicaton and updated scope API docs 2

* Added more KeyBinding scope tests

* Added more KeyBinding scope tests2

* ConsoleDriverKey too long. Key too ambiguous. Settled on KeyCode. (Partialy because eventually I want to intro a class named Key).

* KeyEventArgs improvements. cast to Rune must be explicit as it's lossy

* Fixed warnings

* Renamed KeyEventArgs to Key... progress on fixing broken stuff that resulted

* Fix ConsoleKeyMapping bugs.

* Fix NetDriver issue from converting a lower case to a upper case.

* Started migration to Key from KeyCode - e.g. made HotKeys all consistent.

* Fixed build warnings

* Added key defns to Key

* KeyBindings now uses Key vs. KeyCode

* Verified by tweaking UICatalog

* Fixed treeview test ... again

* Renamed ProcessKeyDown/Up to NewKeyDown/Up and OnKeyPressed to OnProcessKeyDown to make things more clear

* Added test AllViews_KeyDown_All_EventsFire unit tests and fixed a few Views that were wrong

* fixed stupid KeyUp event bug

* If key not handled, return false for datefield

* dotnet test --no-restore --verbosity diag

* dotnet test --blame

* run tests on windows

* Fix TestVKPacket unit test and move it to ConsoleKeyMappingTests.cs file.

* Remove unnecessary commented code.

* Tweaked unit tests and removed Key.BareKey

* Fixed little details and updated api docs

* updated api docs

* AddKeyBindingsForHotKey: KeyCode->Key

* Cleaned up more old KeyCode usages. Added TODOs

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>
2023-12-16 12:04:23 -07:00

253 lines
6.5 KiB
C#

using System;
using System.Collections.Generic;
using System.Text;
using Xunit;
using Xunit.Abstractions;
namespace Terminal.Gui.ViewsTests {
public class RuneCellTests {
readonly ITestOutputHelper _output;
public RuneCellTests (ITestOutputHelper output)
{
_output = output;
}
[Fact]
public void Constructor_Defaults ()
{
var rc = new RuneCell ();
Assert.NotNull (rc);
Assert.Equal (0, rc.Rune.Value);
Assert.Null (rc.ColorScheme);
}
[Fact]
public void Equals_True ()
{
var rc1 = new RuneCell ();
var rc2 = new RuneCell ();
Assert.True (rc1.Equals (rc2));
Assert.True (rc2.Equals (rc1));
rc1.Rune = new Rune ('a');
rc1.ColorScheme = new ColorScheme ();
rc2.Rune = new Rune ('a');
rc2.ColorScheme = new ColorScheme ();
Assert.True (rc1.Equals (rc2));
Assert.True (rc2.Equals (rc1));
}
[Fact]
public void Equals_False ()
{
var rc1 = new RuneCell ();
var rc2 = new RuneCell () {
Rune = new Rune ('a'),
ColorScheme = new ColorScheme () { Normal = new Attribute (Color.Red) }
};
Assert.False (rc1.Equals (rc2));
Assert.False (rc2.Equals (rc1));
rc1.Rune = new Rune ('a');
rc1.ColorScheme = new ColorScheme ();
Assert.Equal (rc1.Rune, rc2.Rune);
Assert.False (rc1.Equals (rc2));
Assert.False (rc2.Equals (rc1));
}
[Fact]
public void ToString_Override ()
{
var rc1 = new RuneCell ();
var rc2 = new RuneCell () {
Rune = new Rune ('a'),
ColorScheme = new ColorScheme () { Normal = new Attribute (Color.Red) }
};
Assert.Equal ("U+0000 '\0'; null", rc1.ToString ());
Assert.Equal ("U+0061 'a'; Normal: Red,Red; Focus: White,Black; HotNormal: White,Black; HotFocus: White,Black; Disabled: White,Black", rc2.ToString ());
}
// TODO: Move the tests below to View or Color - they test ColorScheme, not RuneCell primitives.
private TextView CreateTextView ()
{
return new TextView () { Width = 30, Height = 10 };
}
[Fact, AutoInitShutdown]
public void RuneCell_LoadRuneCells_InheritsPreviousColorScheme ()
{
List<RuneCell> runeCells = new List<RuneCell> ();
foreach (var color in Colors.ColorSchemes) {
string csName = color.Key;
foreach (var rune in csName.EnumerateRunes ()) {
runeCells.Add (new RuneCell { Rune = rune, ColorScheme = color.Value });
}
runeCells.Add (new RuneCell { Rune = (Rune)'\n', ColorScheme = color.Value });
}
var tv = CreateTextView ();
tv.Load (runeCells);
Application.Top.Add (tv);
var rs = Application.Begin (Application.Top);
Assert.True (tv.InheritsPreviousColorScheme);
var expectedText = @"
TopLevel
Base
Dialog
Menu
Error ";
TestHelpers.AssertDriverContentsWithFrameAre (expectedText, _output);
var attributes = new Attribute [] {
// 0
Colors.TopLevel.Focus,
// 1
Colors.Base.Focus,
// 2
Colors.Dialog.Focus,
// 3
Colors.Menu.Focus,
// 4
Colors.Error.Focus
};
var expectedColor = @"
0000000000
1111000000
2222220000
3333000000
4444400000";
TestHelpers.AssertDriverColorsAre (expectedColor, driver: Application.Driver, attributes);
tv.WordWrap = true;
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (expectedText, _output);
TestHelpers.AssertDriverColorsAre (expectedColor, driver: Application.Driver, attributes);
tv.CursorPosition = new Point (6, 2);
tv.SelectionStartColumn = 0;
tv.SelectionStartRow = 0;
Assert.Equal ($"TopLevel{Environment.NewLine}Base{Environment.NewLine}Dialog", tv.SelectedText);
tv.Copy ();
tv.Selecting = false;
tv.CursorPosition = new Point (2, 4);
tv.Paste ();
Application.Refresh ();
expectedText = @"
TopLevel
Base
Dialog
Menu
ErTopLevel
Base
Dialogror ";
TestHelpers.AssertDriverContentsWithFrameAre (expectedText, _output);
expectedColor = @"
0000000000
1111000000
2222220000
3333000000
4444444444
4444000000
4444444440";
TestHelpers.AssertDriverColorsAre (expectedColor, driver: Application.Driver, attributes);
tv.Undo ();
tv.CursorPosition = new Point (0, 3);
tv.SelectionStartColumn = 0;
tv.SelectionStartRow = 0;
Assert.Equal ($"TopLevel{Environment.NewLine}Base{Environment.NewLine}Dialog{Environment.NewLine}", tv.SelectedText);
tv.Copy ();
tv.Selecting = false;
tv.CursorPosition = new Point (2, 4);
tv.Paste ();
Application.Refresh ();
expectedText = @"
TopLevel
Base
Dialog
Menu
ErTopLevel
Base
Dialog
ror ";
TestHelpers.AssertDriverContentsWithFrameAre (expectedText, _output);
expectedColor = @"
0000000000
1111000000
2222220000
3333000000
4444444444
4444000000
4444440000
4440000000";
TestHelpers.AssertDriverColorsAre (expectedColor, driver: Application.Driver, attributes);
Application.End (rs);
}
[Fact, AutoInitShutdown]
public void RuneCell_LoadRuneCells_Without_ColorScheme_Is_Never_Null ()
{
var cells = new List<RuneCell> {
new RuneCell{Rune = new Rune ('T')},
new RuneCell{Rune = new Rune ('e')},
new RuneCell{Rune = new Rune ('s')},
new RuneCell{Rune = new Rune ('t')}
};
var tv = CreateTextView ();
Application.Top.Add (tv);
tv.Load (cells);
for (int i = 0; i < tv.Lines; i++) {
var line = tv.GetLine (i);
foreach (var rc in line) {
Assert.NotNull (rc.ColorScheme);
}
}
}
[Fact, AutoInitShutdown]
public void RuneCellEventArgs_WordWrap_True ()
{
var eventCount = 0;
var text = new List<List<RuneCell>> () { TextModel.ToRuneCells ("This is the first line.".ToRunes ()), TextModel.ToRuneCells ("This is the second line.".ToRunes ()) };
var tv = CreateTextView ();
tv.DrawNormalColor += _textView_DrawColor;
tv.DrawReadOnlyColor += _textView_DrawColor;
tv.DrawSelectionColor += _textView_DrawColor;
tv.DrawUsedColor += _textView_DrawColor;
void _textView_DrawColor (object sender, RuneCellEventArgs e)
{
Assert.Equal (e.Line [e.Col], text [e.UnwrappedPosition.Row] [e.UnwrappedPosition.Col]);
eventCount++;
}
tv.Text = $"{TextModel.ToString (text [0])}\n{TextModel.ToString (text [1])}\n";
Assert.False (tv.WordWrap);
Application.Top.Add (tv);
Application.Begin (Application.Top);
TestHelpers.AssertDriverContentsWithFrameAre (@"
This is the first line.
This is the second line.", _output);
tv.Width = 10;
tv.Height = 25;
tv.WordWrap = true;
Application.Refresh ();
TestHelpers.AssertDriverContentsWithFrameAre (@"
This is
the
first
line.
This is
the
second
line. ", _output);
Assert.Equal (eventCount, (text [0].Count + text [1].Count) * 2);
}
}
}