Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 07:47:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixes #4223. SendKeys scenario is broken and does not support surrogate pairs (#4224)

Browse Source 
* Fixes #4223. SendKeys scenario is broken and does not support surrogate pairs

* Fix v2 application tests

* Fixes v2 _input being null before initialization

* Add a limit of iterations to avoid loop forever

* Simplify unit tests failure fix

* Fixes #3947 Adds Fake driver and fixes fluent tests (iteration-zero) (#4225)

* Consider width2 chars that are not IsBmp

* Apply same fix in WindowsDriver

* Explicitly use type of local variable

* Revert changes to WindowsDriver

* Assume we are running in a terminal that supports true color by default unless user explicitly forces 16

* Switch to SetAttribute and WriteConsole instead of WriteConsoleOutput for 16 color mode

* Fix some cursor issues (WIP)

* Remove concept of 'dirty rows' from v2 as its never actually used

* Remove damageRegion as it does nothing

* Make string builder to console writing simpler

* Radically simplify Write method

* Simplify conditional logic

* Simplify restoring cursor position

* Reference local variable for console buffer

* Reduce calls to ConsoleWrite by accumulating till attribute changes

* When resizing v2 16 color mode on windows, recreate the back buffer to match its size

* Fixes for VTS enabled

* Fix _lastSize never being assigned

* Fixes VTS for Force16Colors

* Fixes force16Colors in VTS

* Fixes escape sequences always echoing in non-VTS

* Force Force16Colors in non-VTS. It have a bug in adding a newline in the last line

* WIP Add base class for NetOutput

* Abstract away how we change attribute

* WIP - Make WindowsOutput use base class

* WIP working to fix set cursor position

* Remove commented out code

* Fixes legacy output mode

* Fixes size with no alt buffer supported on VTS and size restore after maximized.

* Fix set cursor which also fixes the broken surrogate pairs

* Add force parameter

* Fixes an issue that only happens with Windows Terminal when paste surrogate pairs by press Ctrl+V

* In Windows escape sequences must be sent during the lifetime of the console which is created in input handle

* Ensure flush the input buffer before reset the console

* Flush input buffer before reset console in v2win

* Fixes issue in v2net not being refreshing the menu bar at start

* Only force layout and draw on size changed.

* Fix v2net issue not draw first line by forcing set cursor position

* Set _lastCursorPosition nullable and remove bool force from set cursor position

* Remove force parameter

* Add v2 version of fake driver attribute

* Make direct replacement and wire up window resizing events

* Update casts to use V2 fake driver instead

* Adjust interfaces to expose less internals

* Fix not raising iteration event in v2

* WIP investigate what it takes to do resize and redraw using TextAlignment_Centered as example

* Sketch adding component factory

* Create relevant fake component factories

* Add window size monitor into factory

* Fake size monitor injecting

* Add helper for faking console resize in AutoInitShutdown tests

* Fix size setting in FakeDriverV2

* Switch to new method

* Fix IsLegacy becoming false when using blank constructor

* Fix for Ready not being raised when showing same top twice also fixes garbage collection issue if running millions of top levels

* Fix tests

* Remove auto init

* Restore conditional compilation stuff

* Restore 'if running unit tests' logic

* Check only for the output being specific classes for the suppression

* Fix ShadowView blowing up with index out of bounds error

* Fix resize in fluent tests

* Fix for people using Iteration call directly

* Fix more calls to iteration to use
        AutoInitShutdownAttribute.RunIteration ();

* Add comment

* Remove assumption that Run with prior view not disposed should throw

* Fix timings in Dialog_Opened_From_Another_Dialog

* Fix Zero_Buttons_Works

* Standardize and fix Button_IsDefault_True_Return_His_Index_On_Accepting

* Fix iteration counts on MessageBoxTests

* Fix WizartTests and DrawTests_Ruler

* Implement SendKeys into ConsoleDriverFacade

* Fix SendKeys in console driver facade such that FileDialogTests works
Fix when Clip is null in popover

* Add missing dispose call to test

* Fix support for Esc in facade SendKeys

* Fix AutocompleteTests

* Fix various tests

* Replace LayoutAndDraw with run iteration

* Fix draw issues

* fix draw order

* Fix run iteration calls

* Fix unit tests

* Fix SendKeys in facade.

* Manipulate upper and lower cases.

* Add IsValidInput method to the interface.

* Fix SendKeys scenario

* Fixes surrogate pairs in the label

* Make tests more sensible - they are testing draw functionality.  Callbacks do not need to happen in Iteration method

* Fix tests and harden cleanup in AutoInitShutdownAttribute v2 lifecycle dispose

* Delete extra create input call

* Fix mocks and order of exceptions thrown in Run when things are not initialized

* Revert use of `MapConsoleKeyInfoToKeyCode`

* Ignore casing as it is not what test is really about

* Clear application top and top levels before each auto init shutdown test

* Fix for unstable tests

* Restore actually working SendKeys code

* option to pass logger in fluent ctor

* restore ToArray

* Fix SendKeys method and add extension to unit test

* Leverage the EscSeqUtils.MapConsoleKeyInfo method to avoid duplicate code

* Remove unnecessary hack

* Using only KeyCode for rKeys

* Recover modifier keys in surrogate pairs

* Reformat

* Remove iteration limit for benchmarking in v2

* remove iteration delay to identify bugs

* Remove nudge to unique key and make Then run on UI thread

* fix fluid assertions

* Ensure UI operations all happen on UI thread

* Add explicit error for WaitIteration during an invoke

* Remove timeout added for debug

* Catch failing asserts better

* Fix screenshot

* Fix null ref

* Fix race condition in processing input

* Test fixing

* Standardize asserts

* Remove calls to layout and draw, remove pointless lock and enable reading Cancelled from Dialog even if it is disposed

* fix bad merge

* Make logs access threadsafe

* add extra wait to remove race between iteration end and assert

* Code cleanup

* Remove test for crash on access Cancelled after dispose as this is no longer a restriction

* Change resize console to run on UI thread - fixing race condition with redrawing

* Restore original frame rate after test

* Restore nudge to unique key

* Code Cleanup

* Fix for cascading failures when an assert fails in a specific test

* fix for bad merge

* Address PR feedback

* Move classes to seperate files and add xmldoc

* xml doc warnings

* More xml comments docs

* Fix spelling

---------

Co-authored-by: BDisp <bd.bdisp@gmail.com>

* Fixes #4231. NativeAot project throws when running the published executable (#4232)

* Fixes #4231. NativeAot project throws when running the published executable

* Code cleanup

---------

Co-authored-by: Tig <tig@users.noreply.github.com>

* Fixes #4236. CursesDriver erase the previous text under the cursor when moving if Force16Colors is true (#4237)

* Fixes #4236. CursesDriver erase the previous text under the cursor when moving if Force16Colors is true

* Still trying to fix fluent unit tests

* Fix nullable issue

---------

Co-authored-by: Tig <tig@users.noreply.github.com>

* Need to use KeyCode to return the desired effect with control keys

* Revert v2 drivers changes

* Fix nullable warnings

* Fixes #4025. Application.Driver.SendKeys should be retired

---------

Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: Thomas Nind <31306100+tznind@users.noreply.github.com>
This commit is contained in:
BDisp
2025-09-13 03:21:51 +01:00
committed by GitHub
parent 18b602e980
commit b3aa9c5717
13 changed files with 80 additions and 660 deletions
Download Patch File Download Diff File Expand all files Collapse all files

115
Examples/UICatalog/Scenarios/SendKeys.cs
View File

@@ -1,115 +0,0 @@
using System.Text;
namespace UICatalog.Scenarios;
[ScenarioMetadata ("SendKeys", "SendKeys sample - Send key combinations.")]
[ScenarioCategory ("Mouse and Keyboard")]
public class SendKeys : Scenario
{
public override void Main ()
{
Application.Init ();
var win = new Window { Title = GetQuitKeyAndName () };
var label = new Label { X = Pos.Center (), Y = Pos.Center () - 6, Text = "Insert the text to send:" };
win.Add (label);
var txtInput = new TextField { X = Pos.Center (), Y = Pos.Center () - 5, Width = 20, Text = "MockKeyPresses" };
win.Add (txtInput);
var ckbShift = new CheckBox { X = Pos.Center (), Y = Pos.Center () - 4, Text = "Shift" };
win.Add (ckbShift);
var ckbAlt = new CheckBox { X = Pos.Center (), Y = Pos.Center () - 3, Text = "Alt" };
win.Add (ckbAlt);
var ckbControl = new CheckBox { X = Pos.Center (), Y = Pos.Center () - 2, Text = "Control" };
win.Add (ckbControl);
label = new Label { X = Pos.Center (), Y = Pos.Center () + 1, Text = "Result keys:" };
win.Add (label);
var txtResult = new TextField { X = Pos.Center (), Y = Pos.Center () + 2, Width = 20 };
win.Add (txtResult);
var rKeys = "";
var rControlKeys = "";
var IsShift = false;
var IsAlt = false;
var IsCtrl = false;
txtResult.KeyDown += (s, e) =>
{
rKeys += e.ToString ();
if (!IsShift && e.IsShift)
{
rControlKeys += " Shift ";
IsShift = true;
}
if (!IsAlt && e.IsAlt)
{
rControlKeys += " Alt ";
IsAlt = true;
}
if (!IsCtrl && e.IsCtrl)
{
rControlKeys += " Ctrl ";
IsCtrl = true;
}
};
var lblShippedKeys = new Label { X = Pos.Center (), Y = Pos.Center () + 3 };
win.Add (lblShippedKeys);
var lblShippedControlKeys = new Label { X = Pos.Center (), Y = Pos.Center () + 5 };
win.Add (lblShippedControlKeys);
var button = new Button { X = Pos.Center (), Y = Pos.Center () + 7, IsDefault = true, Text = "Process keys" };
win.Add (button);
void ProcessInput ()
{
rKeys = "";
rControlKeys = "";
txtResult.Text = "";
IsShift = false;
IsAlt = false;
IsCtrl = false;
txtResult.SetFocus ();
foreach (char r in txtInput.Text)
{
ConsoleKeyInfo consoleKeyInfo = EscSeqUtils.MapConsoleKeyInfo (new (r, ConsoleKey.None, false, false, false));
Application.Driver?.SendKeys (
r,
consoleKeyInfo.Key,
ckbShift.CheckedState == CheckState.Checked || (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
ckbAlt.CheckedState == CheckState.Checked || (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
ckbControl.CheckedState == CheckState.Checked || (consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0
);
}
lblShippedKeys.Text = rKeys;
lblShippedControlKeys.Text = rControlKeys;
txtInput.SetFocus ();
}
button.Accepting += (s, e) => ProcessInput ();
win.KeyDown += (s, e) =>
{
if (e.KeyCode == KeyCode.Enter)
{
ProcessInput ();
e.Handled = true;
}
};
Application.Run (win);
win.Dispose ();
Application.Shutdown ();
}
}

294
Examples/UICatalog/Scenarios/VkeyPacketSimulator.cs
View File

@@ -1,294 +0,0 @@
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
namespace UICatalog.Scenarios;
[ScenarioMetadata ("VkeyPacketSimulator", "Simulates the Virtual Key Packet")]
[ScenarioCategory ("Mouse and Keyboard")]
public class VkeyPacketSimulator : Scenario
{
private static readonly ManualResetEventSlim _stopOutput = new (false);
private readonly List<KeyCode> _keyboardStrokes = new ();
private bool _outputStarted;
private bool _wasUnknown;
public override void Main ()
{
Application.Init ();
var win = new Window { Title = GetQuitKeyAndName () };
var label = new Label { X = Pos.Center (), Text = "Input" };
win.Add (label);
var btnInput = new Button { X = Pos.AnchorEnd (16), Text = "Select Input" };
win.Add (btnInput);
const string ruler = "|123456789";
var inputHorizontalRuler = new Label
{
Y = Pos.Bottom (btnInput), Width = Dim.Fill (), SchemeName = "Error"
};
win.Add (inputHorizontalRuler);
var inputVerticalRuler = new Label
{
Y = Pos.Bottom (btnInput),
Width = 1,
Height = Dim.Percent (50),
SchemeName = "Error",
TextDirection = TextDirection.TopBottom_LeftRight
};
win.Add (inputVerticalRuler);
var tvInput = new TextView
{
Title = "Input",
X = 1,
Y = Pos.Bottom (inputHorizontalRuler),
Width = Dim.Fill (),
Height = Dim.Percent (50) - 1
};
win.Add (tvInput);
label = new() { X = Pos.Center (), Y = Pos.Bottom (tvInput), Text = "Output" };
win.Add (label);
var btnOutput = new Button { X = Pos.AnchorEnd (17), Y = Pos.Top (label), Text = "Select Output" };
win.Add (btnOutput);
var outputHorizontalRuler = new Label
{
Y = Pos.Bottom (btnOutput),
Width = Dim.Fill (),
SchemeName = "Error"
};
win.Add (outputHorizontalRuler);
var outputVerticalRuler = new Label
{
Y = Pos.Bottom(btnOutput),
Width = 1,
Height = Dim.Fill (),
SchemeName = "Error",
TextDirection = TextDirection.TopBottom_LeftRight
};
win.Add (outputVerticalRuler);
var tvOutput = new TextView
{
Title = "Output",
X = 1,
Y = Pos.Bottom (outputHorizontalRuler),
Width = Dim.Fill (),
Height = Dim.Fill (),
ReadOnly = true
};
// Detect unknown keys and reject them.
tvOutput.KeyDown += (s, e) =>
{
//System.Diagnostics.Debug.WriteLine ($"Output - KeyDown: {e.KeyCode}");
if (e.NoAlt.NoCtrl.NoShift == KeyCode.Null)
{
_wasUnknown = true;
e.Handled = true;
return;
}
//System.Diagnostics.Debug.WriteLine ($"Output - KeyPress - _keyboardStrokes: {_keyboardStrokes.Count}");
if (_outputStarted)
{
// If the key wasn't handled by the TextView will popup a Dialog with the keys pressed.
bool? handled = tvOutput.NewKeyDownEvent (e);
if (handled == null || handled == false)
{
if (!tvOutput.NewKeyDownEvent (e))
{
Application.Invoke (
() => MessageBox.Query (
"Keys",
$"'{Key.ToString (
e.KeyCode,
Key.Separator
)}' pressed!",
"Ok"
)
);
}
}
}
e.Handled = true;
_stopOutput.Set ();
};
win.Add (tvOutput);
tvInput.KeyDown += (s, e) =>
{
//System.Diagnostics.Debug.WriteLine ($"Input - KeyDown: {e.KeyCode.Key}");
if (e.KeyCode == Key.Empty)
{
_wasUnknown = true;
e.Handled = true;
}
else
{
_wasUnknown = false;
}
};
tvInput.KeyDownNotHandled += (s, e) =>
{
Key ev = e;
//System.Diagnostics.Debug.WriteLine ($"Input - KeyPress: {ev}");
//System.Diagnostics.Debug.WriteLine ($"Input - KeyPress - _keyboardStrokes: {_keyboardStrokes.Count}");
if (!e.IsValid)
{
_wasUnknown = true;
e.Handled = true;
return;
}
_keyboardStrokes.Add (e.KeyCode);
};
tvInput.KeyUp += (s, e) =>
{
//System.Diagnostics.Debug.WriteLine ($"Input - KeyUp: {e.Key}");
e.Handled = true;
if (!_wasUnknown && _keyboardStrokes.Count > 0)
{
_outputStarted = true;
tvOutput.ReadOnly = false;
tvOutput.SetFocus ();
tvOutput.SetNeedsDraw ();
Task.Run (
() =>
{
while (_outputStarted)
{
try
{
while (_keyboardStrokes.Count > 0)
{
if (_keyboardStrokes [0] == KeyCode.Null)
{
continue;
}
ConsoleKeyInfo consoleKeyInfo =
ConsoleKeyMapping.GetConsoleKeyInfoFromKeyCode (_keyboardStrokes [0]);
char keyChar =
ConsoleKeyMapping.EncodeKeyCharForVKPacket (consoleKeyInfo);
Application.Driver?.SendKeys (
keyChar,
ConsoleKey.Packet,
consoleKeyInfo.Modifiers.HasFlag (ConsoleModifiers.Shift),
consoleKeyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt),
consoleKeyInfo.Modifiers
.HasFlag (ConsoleModifiers.Control)
);
_stopOutput.Wait ();
_stopOutput.Reset ();
_keyboardStrokes.RemoveAt (0);
Application.Invoke (
() =>
{
tvOutput.ReadOnly = true;
tvInput.SetFocus ();
}
);
}
_outputStarted = false;
}
catch (Exception)
{
Application.Invoke (
() =>
{
MessageBox.ErrorQuery (
"Error",
"Couldn't send the keystrokes!",
"Ok"
);
Application.RequestStop ();
}
);
}
}
//System.Diagnostics.Debug.WriteLine ($"_outputStarted: {_outputStarted}");
}
);
}
};
btnInput.Accepting += (s, e) =>
{
if (!tvInput.HasFocus && _keyboardStrokes.Count == 0)
{
tvInput.SetFocus ();
}
};
btnOutput.Accepting += (s, e) =>
{
if (!tvOutput.HasFocus && _keyboardStrokes.Count == 0)
{
tvOutput.SetFocus ();
}
};
tvInput.SetFocus ();
void Win_LayoutComplete (object sender, LayoutEventArgs obj)
{
if (inputHorizontalRuler.Viewport.Width == 0 || inputVerticalRuler.Viewport.Height == 0)
{
return;
}
inputHorizontalRuler.Text = outputHorizontalRuler.Text =
ruler.Repeat (
(int)Math.Ceiling (
inputHorizontalRuler.Viewport.Width
/ (double)ruler.Length
)
) [
..inputHorizontalRuler.Viewport.Width];
inputVerticalRuler.Height = tvInput.Frame.Height + 1;
inputVerticalRuler.Text =
ruler.Repeat ((int)Math.Ceiling (inputVerticalRuler.Viewport.Height / (double)ruler.Length)) [
..inputVerticalRuler.Viewport.Height];
outputVerticalRuler.Text =
ruler.Repeat ((int)Math.Ceiling (outputVerticalRuler.Viewport.Height / (double)ruler.Length)) [
..outputVerticalRuler.Viewport.Height];
}
win.SubViewsLaidOut += Win_LayoutComplete;
Application.Run (win);
win.Dispose ();
Application.Shutdown ();
}
}

26
Terminal.Gui/Drivers/ConsoleDriver.cs
View File

@@ -681,16 +681,6 @@ public abstract class ConsoleDriver : IConsoleDriver
/// <param name="a"></param>
public void OnKeyUp (Key a) { KeyUp?.Invoke (this, a); }
// TODO: Remove this API - it was needed when we didn't have a reliable way to simulate key presses.
// TODO: We now do: Application.RaiseKeyDown and Application.RaiseKeyUp
/// <summary>Simulates a key press.</summary>
/// <param name="keyChar">The key character.</param>
/// <param name="key">The key.</param>
/// <param name="shift">If <see langword="true"/> simulates the Shift key being pressed.</param>
/// <param name="alt">If <see langword="true"/> simulates the Alt key being pressed.</param>
/// <param name="ctrl">If <see langword="true"/> simulates the Ctrl key being pressed.</param>
public abstract void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool ctrl);
internal char _highSurrogate = '\0';
internal bool IsValidInput (KeyCode keyCode, out KeyCode result)
@@ -707,6 +697,22 @@ public abstract class ConsoleDriver : IConsoleDriver
if (_highSurrogate > 0 && char.IsLowSurrogate ((char)keyCode))
{
result = (KeyCode)new Rune (_highSurrogate, (char)keyCode).Value;
if ((keyCode & KeyCode.AltMask) != 0)
{
result |= KeyCode.AltMask;
}
if ((keyCode & KeyCode.CtrlMask) != 0)
{
result |= KeyCode.CtrlMask;
}
if ((keyCode & KeyCode.ShiftMask) != 0)
{
result |= KeyCode.ShiftMask;
}
_highSurrogate = '\0';
return true;

56
Terminal.Gui/Drivers/CursesDriver/CursesDriver.cs
View File

@@ -61,44 +61,6 @@ internal class CursesDriver : ConsoleDriver
}
}
public override void SendKeys (char keyChar, ConsoleKey consoleKey, bool shift, bool alt, bool control)
{
KeyCode key;
if (consoleKey == ConsoleKey.Packet)
{
//var mod = new ConsoleModifiers ();
//if (shift)
//{
// mod |= ConsoleModifiers.Shift;
//}
//if (alt)
//{
// mod |= ConsoleModifiers.Alt;
//}
//if (control)
//{
// mod |= ConsoleModifiers.Control;
//}
var cKeyInfo = new ConsoleKeyInfo (keyChar, consoleKey, shift, alt, control);
cKeyInfo = ConsoleKeyMapping.DecodeVKPacketToKConsoleKeyInfo (cKeyInfo);
key = ConsoleKeyMapping.MapConsoleKeyInfoToKeyCode (cKeyInfo);
}
else
{
key = (KeyCode)keyChar;
}
OnKeyDown (new (key));
OnKeyUp (new (key));
//OnKeyPressed (new KeyEventArgsEventArgs (key));
}
public void StartReportingMouseMoves ()
{
if (!RunningUnitTests)
@@ -638,8 +600,7 @@ internal class CursesDriver : ConsoleDriver
while (wch2 == Curses.KeyMouse)
{
// BUGBUG: Fix this nullable issue.
Key kea = null;
Key? kea = null;
ConsoleKeyInfo [] cki =
{
@@ -648,8 +609,7 @@ internal class CursesDriver : ConsoleDriver
new ('<', 0, false, false, false)
};
code = 0;
// BUGBUG: Fix this nullable issue.
HandleEscSeqResponse (ref code, ref k, ref wch2, ref kea, ref cki);
HandleEscSeqResponse (ref code, ref k, ref wch2, ref kea!, ref cki!);
}
return;
@@ -710,8 +670,7 @@ internal class CursesDriver : ConsoleDriver
k = KeyCode.AltMask | MapCursesKey (wch);
}
// BUGBUG: Fix this nullable issue.
Key key = null;
Key? key = null;
if (code == 0)
{
@@ -741,8 +700,7 @@ internal class CursesDriver : ConsoleDriver
[
new ((char)KeyCode.Esc, 0, false, false, false), new ((char)wch2, 0, false, false, false)
];
// BUGBUG: Fix this nullable issue.
HandleEscSeqResponse (ref code, ref k, ref wch2, ref key, ref cki);
HandleEscSeqResponse (ref code, ref k, ref wch2, ref key!, ref cki!);
return;
}
@@ -875,7 +833,7 @@ internal class CursesDriver : ConsoleDriver
ref KeyCode k,
ref int wch2,
ref Key keyEventArgs,
ref ConsoleKeyInfo [] cki
ref ConsoleKeyInfo []? cki
)
{
ConsoleKey ck = 0;
@@ -899,11 +857,10 @@ internal class CursesDriver : ConsoleDriver
// the given terminator (e.g. mouse) or did not understand format somehow.
// Carry on with the older code for processing curses escape codes
// BUGBUG: Fix this nullable issue.
EscSeqUtils.DecodeEscSeq (
ref consoleKeyInfo,
ref ck,
cki,
cki!,
ref mod,
out _,
out _,
@@ -923,7 +880,6 @@ internal class CursesDriver : ConsoleDriver
OnMouseEvent (new () { Flags = mf, Position = pos });
}
// BUGBUG: Fix this nullable issue.
cki = null;
if (wch2 == 27)

5
Terminal.Gui/Drivers/FakeDriver/FakeDriver.cs
View File

@@ -397,11 +397,6 @@ public class FakeDriver : ConsoleDriver
return FakeConsole.CursorVisible;
}
public override void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
{
MockKeyPressedHandler (new ConsoleKeyInfo (keyChar, key, shift, alt, control));
}
private AnsiResponseParser _parser = new ();
/// <inheritdoc />

8
Terminal.Gui/Drivers/IConsoleDriver.cs
View File

@@ -251,14 +251,6 @@ public interface IConsoleDriver
/// </remarks>
event EventHandler<Key>? KeyUp;
/// <summary>Simulates a key press.</summary>
/// <param name="keyChar">The key character.</param>
/// <param name="key">The key.</param>
/// <param name="shift">If <see langword="true"/> simulates the Shift key being pressed.</param>
/// <param name="alt">If <see langword="true"/> simulates the Alt key being pressed.</param>
/// <param name="ctrl">If <see langword="true"/> simulates the Ctrl key being pressed.</param>
void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool ctrl);
/// <summary>
/// Queues the given <paramref name="request"/> for execution
/// </summary>

15
Terminal.Gui/Drivers/NetDriver/NetDriver.cs
View File

@@ -685,21 +685,6 @@ internal class NetDriver : ConsoleDriver
#region Keyboard Handling
public override void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
{
var input = new InputResult
{
EventType = EventType.Key, ConsoleKeyInfo = new (keyChar, key, shift, alt, control)
};
try
{
ProcessInput (input);
}
catch (OverflowException)
{ }
}
//private ConsoleKeyInfo FromVKPacketToKConsoleKeyInfo (ConsoleKeyInfo consoleKeyInfo)
//{
// if (consoleKeyInfo.Key != ConsoleKey.Packet)

19
Terminal.Gui/Drivers/V2/ConsoleDriverFacade.cs
View File

@@ -417,25 +417,6 @@ internal class ConsoleDriverFacade<T> : IConsoleDriver, IConsoleDriverFacade
/// <summary>Event fired when a mouse event occurs.</summary>
public event EventHandler<MouseEventArgs>? MouseEvent;
/// <summary>Simulates a key press.</summary>
/// <param name="keyChar">The key character.</param>
/// <param name="key">The key.</param>
/// <param name="shift">If <see langword="true"/> simulates the Shift key being pressed.</param>
/// <param name="alt">If <see langword="true"/> simulates the Alt key being pressed.</param>
/// <param name="ctrl">If <see langword="true"/> simulates the Ctrl key being pressed.</param>
public void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool ctrl)
{
ConsoleKeyInfo consoleKeyInfo = new (keyChar, key, shift, alt, ctrl);
Key k = EscSeqUtils.MapKey (consoleKeyInfo);
if (InputProcessor.IsValidInput (k, out k))
{
InputProcessor.OnKeyDown (k);
InputProcessor.OnKeyUp (k);
}
}
/// <summary>
/// Provide proper writing to send escape sequence recognized by the <see cref="ConsoleDriver"/>.
/// </summary>

70
Terminal.Gui/Drivers/WindowsDriver/WindowsDriver.cs
View File

@@ -118,76 +118,6 @@ internal class WindowsDriver : ConsoleDriver
public override bool IsRuneSupported (Rune rune) { return base.IsRuneSupported (rune) && rune.IsBmp; }
public override void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
{
var input = new WindowsConsole.InputRecord
{
EventType = WindowsConsole.EventType.Key
};
var keyEvent = new WindowsConsole.KeyEventRecord
{
bKeyDown = true
};
var controlKey = new WindowsConsole.ControlKeyState ();
if (shift)
{
controlKey |= WindowsConsole.ControlKeyState.ShiftPressed;
keyEvent.UnicodeChar = '\0';
keyEvent.wVirtualKeyCode = ConsoleKeyMapping.VK.SHIFT;
}
if (alt)
{
controlKey |= WindowsConsole.ControlKeyState.LeftAltPressed;
controlKey |= WindowsConsole.ControlKeyState.RightAltPressed;
keyEvent.UnicodeChar = '\0';
keyEvent.wVirtualKeyCode = ConsoleKeyMapping.VK.MENU;
}
if (control)
{
controlKey |= WindowsConsole.ControlKeyState.LeftControlPressed;
controlKey |= WindowsConsole.ControlKeyState.RightControlPressed;
keyEvent.UnicodeChar = '\0';
keyEvent.wVirtualKeyCode = ConsoleKeyMapping.VK.CONTROL;
}
keyEvent.dwControlKeyState = controlKey;
input.KeyEvent = keyEvent;
if (shift || alt || control)
{
ProcessInput (input);
}
keyEvent.UnicodeChar = keyChar;
//if ((uint)key < 255) {
// keyEvent.wVirtualKeyCode = (ushort)key;
//} else {
// keyEvent.wVirtualKeyCode = '\0';
//}
keyEvent.wVirtualKeyCode = (ConsoleKeyMapping.VK)key;
input.KeyEvent = keyEvent;
try
{
ProcessInput (input);
}
catch (OverflowException)
{ }
finally
{
keyEvent.bKeyDown = false;
input.KeyEvent = keyEvent;
ProcessInput (input);
}
}
/// <inheritdoc />
internal override IAnsiResponseParser GetParser () => _parser;

4
Tests/UnitTests/ConsoleDrivers/V2/ApplicationV2Tests.cs
View File

@@ -182,6 +182,7 @@ public class ApplicationV2Tests
})
.Verifiable (Times.Once);
}
private void SetupRunInputMockMethodToBlock (Mock<INetInput> netInput)
{
netInput.Setup (r => r.Run (It.IsAny<CancellationToken> ()))
@@ -361,7 +362,6 @@ public class ApplicationV2Tests
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_QuitKey_Quits ()
{
@@ -407,7 +407,6 @@ public class ApplicationV2Tests
ApplicationImpl.ChangeInstance (orig);
}
[Fact]
public void InitRunShutdown_Generic_IdleForExit ()
{
@@ -511,7 +510,6 @@ public class ApplicationV2Tests
v2.Init (null, "v2net");
v2.Shutdown ();
v2.Shutdown ();
outputMock!.Verify (o => o.Dispose (), Times.Once);

78
Tests/UnitTests/FileServices/FileDialogTests.cs
View File

@@ -22,17 +22,15 @@ public class FileDialogTests ()
//pressing enter will complete the current selection
// unless the event cancels the confirm
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.Equal (cancel, dlg.Canceled);
dlg.Dispose ();
}
[Theory]
[InlineData ("Bob", "csv")]
[InlineData ("𝔹ob", "CSV")]
[Fact]
[AutoInitShutdown]
public void DirectTyping_Allowed (string path, string extension)
public void DirectTyping_Allowed ()
{
FileDialog dlg = GetInitializedFileDialog ();
TextField tf = dlg.SubViews.OfType<TextField> ().First (t => t.HasFocus);
@@ -48,15 +46,15 @@ public class FileDialogTests ()
);
// continue typing the rest of the path
Send (path);
Send ('.', ConsoleKey.OemPeriod);
Send (extension);
Send ("Bob");
Application.RaiseKeyDownEvent ('.');
Send ("csv");
Assert.True (dlg.Canceled);
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.False (dlg.Canceled);
Assert.Equal ($"{path}.{extension}", Path.GetFileName (dlg.Path));
Assert.Equal ("Bob.csv", Path.GetFileName (dlg.Path));
dlg.Dispose ();
}
@@ -81,14 +79,14 @@ public class FileDialogTests ()
Assert.Equal ("x", Path.GetFileName (dlg.Path));
// complete auto typing
Send ('\t', ConsoleKey.Tab);
Application.RaiseKeyDownEvent ('\t');
// but do not close dialog
Assert.True (dlg.Canceled);
Assert.EndsWith ("xx" + Path.DirectorySeparatorChar, dlg.Path);
// press enter again to confirm the dialog
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.False (dlg.Canceled);
Assert.EndsWith ("xx" + Path.DirectorySeparatorChar, dlg.Path);
dlg.Dispose ();
@@ -115,15 +113,15 @@ public class FileDialogTests ()
Assert.True (dlg.Canceled);
//pressing enter while search focused should not confirm path
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.True (dlg.Canceled);
// tabbing out of search
Send ('\t', ConsoleKey.Tab);
Application.RaiseKeyDownEvent ('\t');
//should allow enter to confirm path
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
// Dialog has not yet been confirmed with a choice
Assert.False (dlg.Canceled);
@@ -194,21 +192,21 @@ public class FileDialogTests ()
Assert.IsType<TableView> (dlg.MostFocused);
// Try to toggle '..'
Send (' ', ConsoleKey.Spacebar);
Send ('v', ConsoleKey.DownArrow);
Application.RaiseKeyDownEvent (' ');
Application.RaiseKeyDownEvent (Key.CursorDown);
// Toggle subfolder
Send (' ', ConsoleKey.Spacebar);
Application.RaiseKeyDownEvent (' ');
Assert.True (dlg.Canceled);
if (acceptWithEnter)
{
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
}
else
{
Send ('O', ConsoleKey.O, false, true);
Application.RaiseKeyDownEvent ('O');
}
Assert.False (dlg.Canceled);
@@ -250,20 +248,20 @@ public class FileDialogTests ()
Assert.IsType<TableView> (dlg.MostFocused);
// Move selection to subfolder
Send ('v', ConsoleKey.DownArrow);
Application.RaiseKeyDownEvent (Key.CursorDown);
// Toggle subfolder
Send (' ', ConsoleKey.Spacebar);
Application.RaiseKeyDownEvent (' ');
Assert.True (dlg.Canceled);
if (acceptWithEnter)
{
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
}
else
{
Send ('O', ConsoleKey.O, false, true);
Application.RaiseKeyDownEvent (Key.O.WithAlt);
}
Assert.False (dlg.Canceled);
@@ -303,9 +301,9 @@ public class FileDialogTests ()
Assert.IsType<TableView> (dlg.MostFocused);
// Move selection to subfolder
Send ('v', ConsoleKey.DownArrow);
Application.RaiseKeyDownEvent (Key.CursorDown);
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
// Path should update to the newly opened folder
AssertIsTheSubfolder (dlg.Path);
@@ -347,13 +345,13 @@ public class FileDialogTests ()
Assert.IsType<TableView> (dlg.MostFocused);
// Should be selecting ..
Send ('v', ConsoleKey.DownArrow);
Application.RaiseKeyDownEvent (Key.CursorDown);
// Down to the directory
Assert.True (dlg.Canceled);
// Alt+O to open (enter would just navigate into the child dir)
Send ('O', ConsoleKey.O, false, true);
Application.RaiseKeyDownEvent (Key.O.WithAlt);
Assert.False (dlg.Canceled);
AssertIsTheSubfolder (dlg.Path);
@@ -374,8 +372,8 @@ public class FileDialogTests ()
// whe first opening the text field will have select all on
// so to add to current path user must press End or right
Send ('>', ConsoleKey.LeftArrow);
Send ('>', ConsoleKey.RightArrow);
Application.RaiseKeyDownEvent (Key.CursorLeft);
Application.RaiseKeyDownEvent (Key.CursorRight);
Send ("subfolder");
@@ -383,7 +381,7 @@ public class FileDialogTests ()
Assert.True (dlg.Canceled);
// Now it has
Send ('\n', ConsoleKey.Enter);
Application.RaiseKeyDownEvent (Key.Enter);
Assert.False (dlg.Canceled);
AssertIsTheSubfolder (dlg.Path);
dlg.Dispose ();
@@ -765,23 +763,11 @@ public class FileDialogTests ()
private bool IsWindows () { return RuntimeInformation.IsOSPlatform (OSPlatform.Windows); }
private void Send (char ch, ConsoleKey ck, bool shift = false, bool alt = false, bool control = false)
{
Application.Driver?.SendKeys (ch, ck, shift, alt, control);
}
private void Send (string chars)
{
foreach (char ch in chars)
{
ConsoleKeyInfo consoleKeyInfo = EscSeqUtils.MapConsoleKeyInfo (new (ch, ConsoleKey.None, false, false, false));
Application.Driver?.SendKeys (
ch,
consoleKeyInfo.Key,
(consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
(consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
(consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0);
Application.RaiseKeyDownEvent (ch);
}
}
@@ -789,11 +775,11 @@ public class FileDialogTests ()
{
if (Path.DirectorySeparatorChar == '/')
{
Send ('/', ConsoleKey.Separator);
Application.RaiseKeyDownEvent ('/');
}
else
{
Send ('\\', ConsoleKey.Separator);
Application.RaiseKeyDownEvent ('\\');
}
}

42
Tests/UnitTests/Views/AppendAutocompleteTests.cs
View File

@@ -12,7 +12,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting ("fish");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -21,7 +21,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// When cancelling autocomplete
Application.Driver?.SendKeys ('e', ConsoleKey.Escape, false, false, false);
Application.RaiseKeyDownEvent (Key.Esc);
// Suggestion should disappear
tf.Draw ();
@@ -33,7 +33,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Same (tf, Application.Top.Focused);
// But can tab away
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.NotSame (tf, Application.Top.Focused);
Application.Top.Dispose ();
}
@@ -45,7 +45,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting ("fish");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -54,7 +54,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// When cancelling autocomplete
Application.Driver?.SendKeys ('\0', ConsoleKey.Escape, false, false, false);
Application.RaiseKeyDownEvent (Key.Esc);
// Suggestion should disappear
tf.Draw ();
@@ -62,7 +62,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// Should reappear when you press next letter
Application.Driver?.SendKeys ('i', ConsoleKey.I, false, false, false);
Application.RaiseKeyDownEvent (Key.I);
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -74,14 +74,14 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
[Theory]
[AutoInitShutdown]
[InlineData (ConsoleKey.UpArrow)]
[InlineData (ConsoleKey.DownArrow)]
public void TestAutoAppend_CycleSelections (ConsoleKey cycleKey)
[InlineData (KeyCode.CursorUp)]
[InlineData (KeyCode.CursorDown)]
public void TestAutoAppend_CycleSelections (KeyCode cycleKey)
{
TextField tf = GetTextFieldsInViewSuggesting ("fish", "friend");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -90,7 +90,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// When cycling autocomplete
Application.Driver?.SendKeys (' ', cycleKey, false, false, false);
Application.RaiseKeyDownEvent (cycleKey);
View.SetClipToScreen ();
tf.Draw ();
@@ -100,7 +100,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// Should be able to cycle in circles endlessly
Application.Driver?.SendKeys (' ', cycleKey, false, false, false);
Application.RaiseKeyDownEvent (cycleKey);
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -117,7 +117,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting ("fish");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -126,8 +126,8 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// add a space then go back 1
Application.Driver?.SendKeys (' ', ConsoleKey.Spacebar, false, false, false);
Application.Driver?.SendKeys ('<', ConsoleKey.LeftArrow, false, false, false);
Application.RaiseKeyDownEvent (' ');
Application.RaiseKeyDownEvent (Key.CursorLeft);
View.SetClipToScreen ();
tf.Draw ();
@@ -143,7 +143,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting ("fish");
// f is typed and suggestion is "fish"
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();
@@ -152,7 +152,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("f", tf.Text);
// x is typed and suggestion should disappear
Application.Driver?.SendKeys ('x', ConsoleKey.X, false, false, false);
Application.RaiseKeyDownEvent (Key.X);
View.SetClipToScreen ();
tf.Draw ();
DriverAssert.AssertDriverContentsAre ("fx", output);
@@ -190,7 +190,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Equal ("my f", tf.Text);
// When tab completing the case of the whole suggestion should be applied
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
View.SetClipToScreen ();
tf.Draw ();
DriverAssert.AssertDriverContentsAre ("my FISH", output);
@@ -223,7 +223,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
DriverAssert.AssertDriverContentsAre ("fish", output);
Assert.Equal ("f", tf.Text);
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
View.SetClipToScreen ();
tf.Draw ();
@@ -234,7 +234,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
Assert.Same (tf, Application.Top.Focused);
// Second tab should move focus (nothing to autocomplete)
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.NotSame (tf, Application.Top.Focused);
Application.Top.Dispose ();
}
@@ -249,7 +249,7 @@ public class AppendAutocompleteTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInViewSuggesting (overspillUsing);
// f is typed we should only see 'f' up to size of View (10)
Application.Driver?.SendKeys ('f', ConsoleKey.F, false, false, false);
Application.RaiseKeyDownEvent ('f');
View.SetClipToScreen ();
tf.Draw ();
View.SetClipToScreen ();

8
Tests/UnitTests/Views/TextFieldTests.cs
View File

@@ -146,7 +146,7 @@ public class TextFieldTests (ITestOutputHelper output)
// Caption has no effect when focused
tf.Caption = caption;
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.False (tf.HasFocus);
tf.Draw ();
@@ -166,7 +166,7 @@ public class TextFieldTests (ITestOutputHelper output)
TextField tf = GetTextFieldsInView ();
tf.Caption = caption;
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.False (tf.HasFocus);
tf.Draw ();
@@ -186,7 +186,7 @@ public class TextFieldTests (ITestOutputHelper output)
DriverAssert.AssertDriverContentsAre ("", output);
tf.Caption = "Enter txt";
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
// Caption should appear when not focused and no text
Assert.False (tf.HasFocus);
@@ -218,7 +218,7 @@ public class TextFieldTests (ITestOutputHelper output)
tf.Draw ();
DriverAssert.AssertDriverContentsAre ("", output);
Application.Driver?.SendKeys ('\t', ConsoleKey.Tab, false, false, false);
Application.RaiseKeyDownEvent ('\t');
Assert.False (tf.HasFocus);
View.SetClipToScreen ();