Files
Terminal.Gui/Terminal.Gui/Drivers/UnixDriver/UnixInput.cs
Copilot 2be8397203 Remove legacy drivers, simplify architecture, and reorganize codebase structure (#4270)
* Initial plan

* Remove legacy drivers and reorganize v2 architecture

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

* Extract Windows key helper utilities and fix build

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

* Fix all test references to legacy drivers

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

* Update documentation to reflect new driver architecture

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

* Remove V2.cd diagram file

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

* Fix test failures: support legacy drivers and update exception handling

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

* updated driver names

* Move V2 tests from ConsoleDrivers/V2 to proper locations

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

* Rename ApplicationV2 to ModernApplicationImpl to remove v2 terminology

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

* Remove V2 terminology from test drivers and FakeDriver classes

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

* Merge ModernApplicationImpl into ApplicationImpl and move to App folder

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

* Create modern FakeDriver with component factory architecture in Terminal.Gui project

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

* Refactor: Move non-platform-dependent code from /Drivers to /App

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

* Code cleanup and org

* Unit test reorg

* Refactor MainLoop architecture: rename classes and enhance documentation for clarity

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

* Add comprehensive FakeDriver tests (WIP - some tests need fixes)

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

* Fixed FakeDriver build failures

* Fix all FakeDriver test failures - Application.Top creation and clipboard behaviors

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

* Fixed FakeDriver build failures2

* Remove hanging legacy FakeDriver tests that use Console.MockKeyPresses

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

* Fixed some tests

* Fixed more tests

* Fixed more tests

* Fix bad copilot (#4277)

* Update Terminal.Gui/Drivers/FakeDriver/FakeConsoleOutput.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Refactor Application Init and Update Tests

Refactored `Application.Init` to improve initialization logic:
- Added fallback to `ForceDriver` when `driverName` is null.
- Changed repeated `Init` calls to throw `InvalidOperationException`.
- Updated `_driverName` assignment logic for robustness.

Enhanced `IConsoleDriver` with detailed remarks on implementations.

Revised test cases to align with updated `Application.Init` behavior:
- Replaced `FakeDriver` with `null` and `driverName: "fake"`.
- Skipped or commented out tests incompatible with new logic.
- Improved formatting and removed redundant setup code.

Improved code style and consistency across the codebase:
- Standardized parameter formatting and spacing.
- Removed outdated comments and unused code.

General cleanup to enhance readability and maintainability.

* Warp fix copilot (#4278)

* More fixes (#4279)

* Fixes/works around test failures and temporarily disable failing test

Updated `FakeDriver` to set `RunningUnitTests` to `true` and initialize dimensions using `FakeConsole`. Modified `TestRespondersDisposedAttribute` to set `ConsoleDriver.RunningUnitTests` in the `Before` method, ensuring proper behavior during unit tests.

Temporarily disabled the `Button_CanFocus_False_Raises_Accepted_Correctly` test in `ViewCommandTests` by adding a `Skip` parameter to the `[Fact]` attribute, referencing issue #4270.

* Allow all tests to run despite failures in UnitTests

Modified the `dotnet test` command in the `Run UnitTestsParallelizable` step to set `xunit.stopOnFail` to `false`. This ensures that the test runner does not stop execution on the first failure, allowing all tests to execute regardless of individual test outcomes.

* Refactor ApplicationScreenTests for cleaner setup/teardown

Refactored `ClearContents_Called_When_Top_Frame_Changes` test:
- Added `[AutoInitShutdown]` attribute for automatic lifecycle management.
- Replaced manual `Application.Init` and `Application.Top` setup with `Application.Begin` and `RunState`.
- Simplified event handling by defining `ClearedContents` handler inline.
- Removed explicit cleanup logic, relying on `Application.End` for teardown.

Updated `using` directives to include `UnitTests` namespace.

* Attempt to fix intermittent local test failures.

Update ApplicationImpl initialization parameter

Changed the second parameter of the `impl.Init` method in the
`FakeApplicationFactory` class from `"dotnet"` to `"fake"`.

* Code cleanup to cause Action to re-run.

* Stop tests on first failure in UnitTestsParallelizable

Updated the `dotnet test` command in `unit-tests.yml` to set the `xunit.stopOnFail` parameter to `true`. This change ensures that test execution halts immediately upon encountering a failure, allowing quicker identification and resolution of issues. Note that this may prevent the full test suite from running in the event of a failure.

* Allow all tests to run despite failures in CI

Updated `unit-tests.yml` to set `xunit.stopOnFail` to `false`
in both `Run UnitTests` and `Run UnitTestsParallelizable`
steps. This ensures that the test runner does not stop
execution on the first test failure, allowing all tests
to complete even if some fail.

* Enhance RuneExtensions docs and update user dictionary

Updated the `<remarks>` section in `RuneExtensions.GetColumns` to include details about the `wcwidth` implementation and improved readability with `<para>` tags. Added `wcwidth` to the user dictionary in `Terminal.sln.DotSettings` to avoid spelling errors.

* Improve XML doc formatting in RuneExtensions.cs

Updated the remarks section of the `GetColumns` method in the
`RuneExtensions` class to enhance readability by reformatting
and properly indenting `<para>` tags. The content remains
unchanged, describing the method's implementation via `wcwidth`
and its role as a Terminal.Gui extension for `System.Text.Rune`.

* Refactor drivers and improve clipboard handling

Replaced legacy drivers (`CursesDriver`, `NetDriver`) with
`UnixDriver` and `DotNetDriver` across the codebase, including
comments, method names, and test cases. Updated documentation
and remarks to reflect the new driver names and platforms.

Revamped clipboard handling with new platform-specific
implementations: `UnixClipboard` for Unix, `MacOSXClipboard`
for macOS, and `WSLClipboard` for Linux under WSL. Removed
the old `CursesClipboard` and consolidated clipboard logic.

Updated test cases to align with the new drivers and clipboard
implementations. Improved naming consistency and cleaned up
redundant code. Updated the README and documentation to
reflect these changes.

* Remove `PlatformColor` from `Attribute` struct

This commit removes the `PlatformColor` property from the `Attribute` struct, simplifying the codebase by eliminating platform-specific color handling. The following changes were made:

- Removed `PlatformColor` from the `Attribute` struct, including its initialization, usage, and related comments.
- Updated constructors to no longer initialize or use `PlatformColor`.
- Modified `Equals` and `GetHashCode` methods to exclude `PlatformColor`.
- Updated `UnixComponentFactory` documentation to remove references to "v2unix."
- Renamed `v2TestDriver` to `testDriver` in the `With` class for clarity.
- Removed `PlatformColor` references in `DriverAssert` and related error messages.
- Deleted test cases in `AttributeTests` that relied on `PlatformColor`.
- Cleaned up comments and TODOs related to `PlatformColor` and `UnixDriver`.

These changes reflect a shift away from platform-dependent color management, improving code clarity and reducing complexity.

Remove `PlatformColor` and simplify `Attribute` logic

The `PlatformColor` property has been removed from the `Attribute` struct, along with its associated logic, simplifying the codebase and eliminating platform-specific dependencies. Constructors, equality checks, and hash code generation in `Attribute` have been updated accordingly.

The `CurrentAttribute` property in `ConsoleDriver` and `OutputBuffer` has been simplified, removing dependencies on `Application.Driver`. The `MakeColor` method logic has been removed or simplified in related classes.

Tests in `AttributeTests` have been refactored to reflect these changes, focusing on `Foreground`, `Background`, and `Style`. Unix-specific logic tied to `PlatformColor` has been eliminated.

Additional updates include renaming parameters in the `With` class for clarity, simplifying `DriverAssert` output, and performing minor code cleanups to improve readability and maintainability.

* Refactor Terminal.Gui driver architecture for v2

Updated documentation to reflect the new modular driver architecture in Terminal.Gui v2.

- Revised `namespace-drivers.md` to include new components (`IConsoleInput`, `IConsoleOutput`, `IInputProcessor`, `IOutputBuffer`, `IWindowSizeMonitor`) and terminal size monitoring.
- Replaced "Key Components" with "Architecture Overview" and added details on the **Component Factory** pattern.
- Documented the four driver implementations (`DotNetDriver`, `WindowsDriver`, `UnixDriver`, `FakeDriver`) and their platform-specific optimizations.
- Added a "Threading Model" section to explain the multi-threaded design for responsive input handling.
- Updated examples to demonstrate driver capabilities and explicit driver selection.

In `drivers.md`:
- Expanded the "Overview" to emphasize the modular, component-based architecture.
- Reorganized "Drivers" into "Available Drivers" and added details on `FakeDriver` for unit testing.
- Added sections on "Initialization Flow," "Shutdown Flow," and platform-specific driver details.
- Provided examples for accessing driver components and creating custom drivers.

In `index.md`:
- Updated "Cross Platform" feature to reflect new driver names and clarified compatibility with SSH and monochrome terminals.

* Moved files around

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: tig <585482+tig@users.noreply.github.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: Thomas Nind <31306100+tznind@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-15 13:24:47 -06:00

267 lines
7.6 KiB
C#

using System.Runtime.InteropServices;
using Microsoft.Extensions.Logging;
namespace Terminal.Gui.Drivers;
internal class UnixInput : ConsoleInput<char>, IUnixInput
{
private const int STDIN_FILENO = 0;
[StructLayout (LayoutKind.Sequential)]
private struct Termios
{
public uint c_iflag;
public uint c_oflag;
public uint c_cflag;
public uint c_lflag;
[MarshalAs (UnmanagedType.ByValArray, SizeConst = 32)]
public byte [] c_cc;
public uint c_ispeed;
public uint c_ospeed;
}
[DllImport ("libc", SetLastError = true)]
private static extern int tcgetattr (int fd, out Termios termios);
[DllImport ("libc", SetLastError = true)]
private static extern int tcsetattr (int fd, int optional_actions, ref Termios termios);
// try cfmakeraw (glibc and macOS usually export it)
[DllImport ("libc", EntryPoint = "cfmakeraw", SetLastError = false)]
private static extern void cfmakeraw_ref (ref Termios termios);
[DllImport ("libc", SetLastError = true)]
private static extern nint strerror (int err);
private const int TCSANOW = 0;
private const ulong BRKINT = 0x00000002;
private const ulong ICRNL = 0x00000100;
private const ulong INPCK = 0x00000010;
private const ulong ISTRIP = 0x00000020;
private const ulong IXON = 0x00000400;
private const ulong OPOST = 0x00000001;
private const ulong ECHO = 0x00000008;
private const ulong ICANON = 0x00000100;
private const ulong IEXTEN = 0x00008000;
private const ulong ISIG = 0x00000001;
private const ulong CS8 = 0x00000030;
private Termios _original;
[StructLayout (LayoutKind.Sequential)]
private struct Pollfd
{
public int fd;
public short events;
public readonly short revents; // readonly signals "don't touch this in managed code"
}
/// <summary>Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions.</summary>
[Flags]
private enum Condition : short
{
/// <summary>There is data to read</summary>
PollIn = 1,
/// <summary>There is urgent data to read</summary>
PollPri = 2,
/// <summary>Writing to the specified descriptor will not block</summary>
PollOut = 4,
/// <summary>Error condition on output</summary>
PollErr = 8,
/// <summary>Hang-up on output</summary>
PollHup = 16,
/// <summary>File descriptor is not open.</summary>
PollNval = 32
}
[DllImport ("libc", SetLastError = true)]
private static extern int poll ([In][Out] Pollfd [] ufds, uint nfds, int timeout);
[DllImport ("libc", SetLastError = true)]
private static extern int read (int fd, byte [] buf, int count);
// File descriptor for stdout
private const int STDOUT_FILENO = 1;
[DllImport ("libc", SetLastError = true)]
private static extern int write (int fd, byte [] buf, int count);
[DllImport ("libc", SetLastError = true)]
private static extern int tcflush (int fd, int queueSelector);
private const int TCIFLUSH = 0; // flush data received but not read
private Pollfd [] _pollMap;
public UnixInput ()
{
Logging.Logger.LogInformation ($"Creating {nameof (UnixInput)}");
if (ConsoleDriver.RunningUnitTests)
{
return;
}
_pollMap = new Pollfd [1];
_pollMap [0].fd = STDIN_FILENO; // stdin
_pollMap [0].events = (short)Condition.PollIn;
EnableRawModeAndTreatControlCAsInput ();
//Enable alternative screen buffer.
WriteRaw (EscSeqUtils.CSI_SaveCursorAndActivateAltBufferNoBackscroll);
//Set cursor key to application.
WriteRaw (EscSeqUtils.CSI_HideCursor);
WriteRaw (EscSeqUtils.CSI_EnableMouseEvents);
}
private void EnableRawModeAndTreatControlCAsInput ()
{
if (tcgetattr (STDIN_FILENO, out _original) != 0)
{
var e = Marshal.GetLastWin32Error ();
throw new InvalidOperationException ($"tcgetattr failed errno={e} ({StrError (e)})");
}
var raw = _original;
// Prefer cfmakeraw if available
try
{
cfmakeraw_ref (ref raw);
}
catch (EntryPointNotFoundException)
{
// fallback: roughly cfmakeraw equivalent
raw.c_iflag &= ~((uint)BRKINT | (uint)ICRNL | (uint)INPCK | (uint)ISTRIP | (uint)IXON);
raw.c_oflag &= ~(uint)OPOST;
raw.c_cflag |= (uint)CS8;
raw.c_lflag &= ~((uint)ECHO | (uint)ICANON | (uint)IEXTEN | (uint)ISIG);
}
if (tcsetattr (STDIN_FILENO, TCSANOW, ref raw) != 0)
{
var e = Marshal.GetLastWin32Error ();
throw new InvalidOperationException ($"tcsetattr failed errno={e} ({StrError (e)})");
}
}
private string StrError (int err)
{
var p = strerror (err);
return p == nint.Zero ? $"errno={err}" : Marshal.PtrToStringAnsi (p) ?? $"errno={err}";
}
/// <inheritdoc />
protected override bool Peek ()
{
try
{
if (ConsoleDriver.RunningUnitTests)
{
return false;
}
int n = poll (_pollMap!, (uint)_pollMap!.Length, 0);
if (n != 0)
{
return true;
}
return false;
}
catch (Exception ex)
{
// Optionally log the exception
Logging.Logger.LogError ($"Error in Peek: {ex.Message}");
return false;
}
}
private void WriteRaw (string text)
{
if (!ConsoleDriver.RunningUnitTests)
{
byte [] utf8 = Encoding.UTF8.GetBytes (text);
// Write to stdout (fd 1)
write (STDOUT_FILENO, utf8, utf8.Length);
}
}
/// <inheritdoc/>
protected override IEnumerable<char> Read ()
{
while (poll (_pollMap!, (uint)_pollMap!.Length, 0) != 0)
{
// Check if stdin has data
if ((_pollMap [0].revents & (int)Condition.PollIn) != 0)
{
var buf = new byte [256];
int bytesRead = read (0, buf, buf.Length); // Read from stdin
string input = Encoding.UTF8.GetString (buf, 0, bytesRead);
foreach (char ch in input)
{
yield return ch;
}
}
}
}
private void FlushConsoleInput ()
{
if (!ConsoleDriver.RunningUnitTests)
{
var fds = new Pollfd [1];
fds [0].fd = STDIN_FILENO;
fds [0].events = (short)Condition.PollIn;
var buf = new byte [256];
while (poll (fds, 1, 0) > 0)
{
read (STDIN_FILENO, buf, buf.Length);
}
}
}
/// <inheritdoc />
public override void Dispose ()
{
base.Dispose ();
if (!ConsoleDriver.RunningUnitTests)
{
// Disable mouse events first
WriteRaw (EscSeqUtils.CSI_DisableMouseEvents);
// Drain any pending input already queued by the terminal
FlushConsoleInput ();
// Flush kernel input buffer
tcflush (STDIN_FILENO, TCIFLUSH);
//Disable alternative screen buffer.
WriteRaw (EscSeqUtils.CSI_RestoreCursorAndRestoreAltBufferWithBackscroll);
//Set cursor key to cursor.
WriteRaw (EscSeqUtils.CSI_ShowCursor);
// Restore terminal to original state
tcsetattr (STDIN_FILENO, TCSANOW, ref _original);
}
}
}