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

* 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

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 ();
}
}

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 ();
}
}