Files
Terminal.Gui/UnitTests/KeyTests.cs
Thomas Nind ea7981dc59 Adds Key Binding support. Also refactors Autocomplete and Undo/Redo. (#1556)
* Refactored ProcessKey to use public methods for case logic

* Added KeyBinding class

* Refactored key binding to split key->command from command->implementation

This reduces duplication and simplifies the API

* Finishing key bindings implementation in ListView.

* Adding more unit tests to the ListView.

* Added key bindings to the Button and more features.

* Replaces Action for Func<KeyEvent, bool> on CommandImplementations.

* Allowing commands to have any number of arguments.

* Implementing key bindings on Checkbox view.

* Added test for changing HotKey in Button and made ReplaceKeyBinding protected

* Changed `CommandImplementations` to `Func<KeyEvent, bool>` to better understand current command implementations

* Implementing key bindings in ComboBox.

* Renamed Command keys and fixed ComboBox issues:

- Fixed pressing Esc in ListAndCombos scenario without selecting cause an array out of bounds error
- Changed the Esc key in ComboBox to also collapse the list selection
- Added bool return to public virtual method Expand and Collapse (this is a breaking change)

* Implementing key bindings in DateField.

* Organizing some things.

* Implementing key bindings on TimeField.

* No key bindings on FrameView.

* Added keybinding support to TreeView

* Added mouse support and more features.

* Updating NuGet packages.

* Putting text on the same line.

* Changing function command to Func<bool>.

* Added a read only Position, CursorPosition properties and events.

* Keybindings for GraphView

* Added a stream argument to ApplyEdits to only save the edits.

* Implementing key bindings on the HexView.

* Added MenuOpened event and others bug fixes.

* Fixing typo.

* Unifying constructors initializations.

* Implementing keybindings in the Menu.

* Removing unnecessary variable.

* Implementing keybindings in RadioGroup view.

* Changing Home to TopHome and End to BottomEnd.

* Implementing keybindings in the ScrollView.

* Changing the PageLeft and PageRight keybindings.

* Fixing PageLeft and RightPage.

* Removing CleanUp command.

* Key bindings for TabView

* Keybindings for TableView

* Fixed unit tests for PageDown to correctly assign input focus to the TableView

* Fixes the CalculateLeftColumn method avoiding jump two columns on forward moving.

* Fixes #1525. Gives the same backspace behavior as TextView.

* Changes kill-to-start key to work on Linux too.

* Fixes SelectedStart, SelectedText and some cleaning.

* Implementing keybindings in TextField.

* Updated command names and merged as discussed with @BDisp

- Merged LeftItem and LeftChar to Left (same for Right).
- Also renamed Kill to Cut
- Added ScrollLeft / ScrollRight (and renamed ScrollLineUp to just ScrollUp

* Renamed Command.InsertChar to ToggleOverwriteMode and added Enable/Disable

* Removed 'Mode' suffix from toggle overwrite

* Allows navigation to outside a TextView if IsMdiContainer is true.

* Implementing keybindings in Toplevel.

* Fixing null reference exception.

* Changing to keys instances events instead static.

* Transferring the events to the Toplevel.

* Implementing keybindings in TextView.

* Removing static from the QuitKeyChanged and adding unit test.

* Replacing Added with the Initialized event.

* Ignore control characters and other special keys.

* Changing InvokeKeybindings to return Nullable bool and added two more keys to the Toplevel.

* Implementing keybindings in Autocomplete. I had to derive from View.

* Added keybindings menu item to UICatalog

* Added ClearBinding

* Implementing IAutocomplete, abstract Autocomplete and derived TextViewAutocomplete.

* Implementing keybindings in the TextValidateProvider

* Add keybinding to CellActivationKey.

* Fixing some formats.

* Add ObjectActivationKey to the keybindings.

* Made it much easier to implement abstract base `Autocomplete` in other views by moving methods up out of `TextViewAutocomplete` implementation

* Allowing Autocomplete to popup inside or outside the container.

* Fixes the cursor not being showing if the text length is equal to the view width.

* A unit test to prove the 4df5897.

* Removed unused method `GetCursorPosition` from Autocomplete

* Trimmed down implementation specific methods from IAutocomplete

* Fixed xmldoc comment tag

* Format Autocomplete on multiline and fixes wrap settings.

* Adding keys from a to z to avoid the Key.Space on ToString.

* Fixes the vertical position outside the container.

* Adding more key unit tests.

* Changing comment to upper case and proving that doesn't will breaking nothing.

* Replaces Pos.Bottom to Pos.AnchorEnd.

* Fixes popup on resizing.

* Should only using the Pos.Bottom to position outside the view.

* Fixes #1584

* Fixes https://github.com/migueldeicaza/gui.cs/issues/1584#issuecomment-1027987475

* Fixes some bugs with SelectedItem.

* Command must also return a nullable bool.

* Ensures updating the ComboBox text on leaving the control.

* Only with the nullable bool was possible to make the MoveUp and the MoveDown working.

* Added logging of which scenario failed in test

Co-authored-by: BDisp <bd.bdisp@gmail.com>
2022-02-08 10:40:40 -08:00

172 lines
7.8 KiB
C#

using System;
using Xunit;
namespace Terminal.Gui.Core {
public class KeyTests {
enum SimpleEnum { Zero, One, Two, Three, Four, Five }
[Flags]
enum FlaggedEnum { Zero, One, Two, Three, Four, Five }
enum SimpleHighValueEnum { Zero, One, Two, Three, Four, Last = 0x40000000 }
[Flags]
enum FlaggedHighValueEnum { Zero, One, Two, Three, Four, Last = 0x40000000 }
[Fact]
public void SimpleEnum_And_FlagedEnum ()
{
var simple = SimpleEnum.Three | SimpleEnum.Five;
// Nothing will not be well compared here.
Assert.True (simple.HasFlag (SimpleEnum.Zero | SimpleEnum.Five));
Assert.True (simple.HasFlag (SimpleEnum.One | SimpleEnum.Five));
Assert.True (simple.HasFlag (SimpleEnum.Two | SimpleEnum.Five));
Assert.True (simple.HasFlag (SimpleEnum.Three | SimpleEnum.Five));
Assert.True (simple.HasFlag (SimpleEnum.Four | SimpleEnum.Five));
Assert.True ((simple & (SimpleEnum.Zero | SimpleEnum.Five)) != 0);
Assert.True ((simple & (SimpleEnum.One | SimpleEnum.Five)) != 0);
Assert.True ((simple & (SimpleEnum.Two | SimpleEnum.Five)) != 0);
Assert.True ((simple & (SimpleEnum.Three | SimpleEnum.Five)) != 0);
Assert.True ((simple & (SimpleEnum.Four | SimpleEnum.Five)) != 0);
Assert.Equal (7, (int)simple); // As it is not flagged only shows as number.
Assert.Equal ("7", simple.ToString ());
Assert.False (simple == (SimpleEnum.Zero | SimpleEnum.Five));
Assert.False (simple == (SimpleEnum.One | SimpleEnum.Five));
Assert.True (simple == (SimpleEnum.Two | SimpleEnum.Five));
Assert.True (simple == (SimpleEnum.Three | SimpleEnum.Five));
Assert.False (simple == (SimpleEnum.Four | SimpleEnum.Five));
var flagged = FlaggedEnum.Three | FlaggedEnum.Five;
// Nothing will not be well compared here.
Assert.True (flagged.HasFlag (FlaggedEnum.Zero | FlaggedEnum.Five));
Assert.True (flagged.HasFlag (FlaggedEnum.One | FlaggedEnum.Five));
Assert.True (flagged.HasFlag (FlaggedEnum.Two | FlaggedEnum.Five));
Assert.True (flagged.HasFlag (FlaggedEnum.Three | FlaggedEnum.Five));
Assert.True (flagged.HasFlag (FlaggedEnum.Four | FlaggedEnum.Five));
Assert.True ((flagged & (FlaggedEnum.Zero | FlaggedEnum.Five)) != 0);
Assert.True ((flagged & (FlaggedEnum.One | FlaggedEnum.Five)) != 0);
Assert.True ((flagged & (FlaggedEnum.Two | FlaggedEnum.Five)) != 0);
Assert.True ((flagged & (FlaggedEnum.Three | FlaggedEnum.Five)) != 0);
Assert.True ((flagged & (FlaggedEnum.Four | FlaggedEnum.Five)) != 0);
Assert.Equal (FlaggedEnum.Two | FlaggedEnum.Five, flagged); // As it is flagged shows as bitwise.
Assert.Equal ("Two, Five", flagged.ToString ());
Assert.False (flagged == (FlaggedEnum.Zero | FlaggedEnum.Five));
Assert.False (flagged == (FlaggedEnum.One | FlaggedEnum.Five));
Assert.True (flagged == (FlaggedEnum.Two | FlaggedEnum.Five));
Assert.True (flagged == (FlaggedEnum.Three | FlaggedEnum.Five));
Assert.False (flagged == (FlaggedEnum.Four | FlaggedEnum.Five));
}
[Fact]
public void SimpleHighValueEnum_And_FlaggedHighValueEnum ()
{
var simple = SimpleHighValueEnum.Three | SimpleHighValueEnum.Last;
// This will not be well compared.
Assert.True (simple.HasFlag (SimpleHighValueEnum.Zero | SimpleHighValueEnum.Last));
Assert.True (simple.HasFlag (SimpleHighValueEnum.One | SimpleHighValueEnum.Last));
Assert.True (simple.HasFlag (SimpleHighValueEnum.Two | SimpleHighValueEnum.Last));
Assert.True (simple.HasFlag (SimpleHighValueEnum.Three | SimpleHighValueEnum.Last));
Assert.False (simple.HasFlag (SimpleHighValueEnum.Four | SimpleHighValueEnum.Last));
Assert.True ((simple & (SimpleHighValueEnum.Zero | SimpleHighValueEnum.Last)) != 0);
Assert.True ((simple & (SimpleHighValueEnum.One | SimpleHighValueEnum.Last)) != 0);
Assert.True ((simple & (SimpleHighValueEnum.Two | SimpleHighValueEnum.Last)) != 0);
Assert.True ((simple & (SimpleHighValueEnum.Three | SimpleHighValueEnum.Last)) != 0);
Assert.True ((simple & (SimpleHighValueEnum.Four | SimpleHighValueEnum.Last)) != 0);
// This will be well compared, because the SimpleHighValueEnum.Last have a high value.
Assert.Equal (1073741827, (int)simple); // As it is not flagged only shows as number.
Assert.Equal ("1073741827", simple.ToString ()); // As it is not flagged only shows as number.
Assert.False (simple == (SimpleHighValueEnum.Zero | SimpleHighValueEnum.Last));
Assert.False (simple == (SimpleHighValueEnum.One | SimpleHighValueEnum.Last));
Assert.False (simple == (SimpleHighValueEnum.Two | SimpleHighValueEnum.Last));
Assert.True (simple == (SimpleHighValueEnum.Three | SimpleHighValueEnum.Last));
Assert.False (simple == (SimpleHighValueEnum.Four | SimpleHighValueEnum.Last));
var flagged = FlaggedHighValueEnum.Three | FlaggedHighValueEnum.Last;
// This will not be well compared.
Assert.True (flagged.HasFlag (FlaggedHighValueEnum.Zero | FlaggedHighValueEnum.Last));
Assert.True (flagged.HasFlag (FlaggedHighValueEnum.One | FlaggedHighValueEnum.Last));
Assert.True (flagged.HasFlag (FlaggedHighValueEnum.Two | FlaggedHighValueEnum.Last));
Assert.True (flagged.HasFlag (FlaggedHighValueEnum.Three | FlaggedHighValueEnum.Last));
Assert.False (flagged.HasFlag (FlaggedHighValueEnum.Four | FlaggedHighValueEnum.Last));
Assert.True ((flagged & (FlaggedHighValueEnum.Zero | FlaggedHighValueEnum.Last)) != 0);
Assert.True ((flagged & (FlaggedHighValueEnum.One | FlaggedHighValueEnum.Last)) != 0);
Assert.True ((flagged & (FlaggedHighValueEnum.Two | FlaggedHighValueEnum.Last)) != 0);
Assert.True ((flagged & (FlaggedHighValueEnum.Three | FlaggedHighValueEnum.Last)) != 0);
Assert.True ((flagged & (FlaggedHighValueEnum.Four | FlaggedHighValueEnum.Last)) != 0);
// This will be well compared, because the SimpleHighValueEnum.Last have a high value.
Assert.Equal (FlaggedHighValueEnum.Three | FlaggedHighValueEnum.Last, flagged); // As it is flagged shows as bitwise.
Assert.Equal ("Three, Last", flagged.ToString ()); // As it is flagged shows as bitwise.
Assert.False (flagged == (FlaggedHighValueEnum.Zero | FlaggedHighValueEnum.Last));
Assert.False (flagged == (FlaggedHighValueEnum.One | FlaggedHighValueEnum.Last));
Assert.False (flagged == (FlaggedHighValueEnum.Two | FlaggedHighValueEnum.Last));
Assert.True (flagged == (FlaggedHighValueEnum.Three | FlaggedHighValueEnum.Last));
Assert.False (flagged == (FlaggedHighValueEnum.Four | FlaggedHighValueEnum.Last));
}
[Fact]
public void Key_Enum_Ambiguity_Check ()
{
var key = Key.Y | Key.CtrlMask;
// This will not be well compared.
Assert.True (key.HasFlag (Key.Q | Key.CtrlMask));
Assert.True ((key & (Key.Q | Key.CtrlMask)) != 0);
Assert.Equal (Key.Y | Key.CtrlMask, key);
Assert.Equal ("Y, CtrlMask", key.ToString ());
// This will be well compared, because the Key.CtrlMask have a high value.
Assert.False (key == (Key.Q | Key.CtrlMask));
switch (key) {
case Key.Q | Key.CtrlMask:
// Never goes here.
break;
case Key.Y | Key.CtrlMask:
Assert.True (key == (Key.Y | Key.CtrlMask));
break;
default:
// Never goes here.
break;
}
}
[Fact]
public void Key_ToString ()
{
var k = Key.Y | Key.CtrlMask;
Assert.Equal ("Y, CtrlMask", k.ToString ());
k = Key.CtrlMask | Key.Y;
Assert.Equal ("Y, CtrlMask", k.ToString ());
k = Key.Space;
Assert.Equal ("Space", k.ToString ());
k = Key.Space | Key.D;
Assert.Equal ("d", k.ToString ());
k = (Key)'d';
Assert.Equal ("d", k.ToString ());
k = Key.d;
Assert.Equal ("d", k.ToString ());
k = Key.D;
Assert.Equal ("D", k.ToString ());
// In a console this will always returns Key.D
k = Key.D | Key.ShiftMask;
Assert.Equal ("D, ShiftMask", k.ToString ());
// In a console this will always returns Key.D
k = Key.d | Key.ShiftMask;
Assert.Equal ("d, ShiftMask", k.ToString ());
}
}
}