using System;
using System.Collections;
using System.Collections.Generic;
using Terminal.Gui;
using Xunit;
namespace Terminal.Gui.InputTests {
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 == Application.QuitKey);
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 ());
}
private static object packetLock = new object ();
///
/// Sometimes when using remote tools EventKeyRecord sends 'virtual keystrokes'.
/// These are indicated with the wVirtualKeyCode of 231. When we see this code
/// then we need to look to the unicode character (UnicodeChar) instead of the key
/// when telling the rest of the framework what button was pressed. For full details
/// see: https://github.com/gui-cs/Terminal.Gui/issues/2008
///
[Theory, AutoInitShutdown]
[ClassData (typeof (PacketTest))]
public void TestVKPacket (uint unicodeCharacter, bool shift, bool alt, bool control, uint initialVirtualKey, uint initialScanCode, Key expectedRemapping, uint expectedVirtualKey, uint expectedScanCode)
{
lock (packetLock) {
Application._forceFakeConsole = true;
Application.Init ();
var modifiers = new ConsoleModifiers ();
if (shift) modifiers |= ConsoleModifiers.Shift;
if (alt) modifiers |= ConsoleModifiers.Alt;
if (control) modifiers |= ConsoleModifiers.Control;
var mappedConsoleKey = ConsoleKeyMapping.GetConsoleKeyFromKey (unicodeCharacter, modifiers, out uint scanCode, out uint outputChar);
if ((scanCode > 0 || mappedConsoleKey == 0) && mappedConsoleKey == initialVirtualKey) Assert.Equal (mappedConsoleKey, initialVirtualKey);
else Assert.Equal (mappedConsoleKey, outputChar < 0xff ? outputChar & 0xff | 0xff << 8 : outputChar);
Assert.Equal (scanCode, initialScanCode);
var keyChar = ConsoleKeyMapping.GetKeyCharFromConsoleKey (mappedConsoleKey, modifiers, out uint consoleKey, out scanCode);
//if (scanCode > 0 && consoleKey == keyChar && consoleKey > 48 && consoleKey > 57 && consoleKey < 65 && consoleKey > 91) {
if (scanCode > 0 && keyChar == 0 && consoleKey == mappedConsoleKey) Assert.Equal (0, (double)keyChar);
else Assert.Equal (keyChar, unicodeCharacter);
Assert.Equal (consoleKey, expectedVirtualKey);
Assert.Equal (scanCode, expectedScanCode);
var top = Application.Top;
top.KeyPress += (s, e) => {
var after = ShortcutHelper.GetModifiersKey (e.KeyEvent);
Assert.Equal (expectedRemapping, after);
e.Handled = true;
Application.RequestStop ();
};
var iterations = -1;
Application.Iteration += () => {
iterations++;
if (iterations == 0) Application.Driver.SendKeys ((char)mappedConsoleKey, ConsoleKey.Packet, shift, alt, control);
};
Application.Run ();
Application.Shutdown ();
}
}
public class PacketTest : IEnumerable, IEnumerable