From 75f5a847c06d0b45e7c7533bb85f9adf219ae98b Mon Sep 17 00:00:00 2001 From: BDisp Date: Fri, 17 Oct 2025 00:42:49 +0100 Subject: [PATCH] Fixes #4274. Using Windows Host Console v2win is rendering window size badly using VSDebugConsole.exe (#4275) * Fixes #4274. Using Windows Host Console v2win is rendering window size badly using VSDebugConsole.exe * Fixes #4259. Our wcwidth library is out of date (#4281) * Update package versions and remove hack code from RuneExtensions Updated several package versions in `Directory.Packages.props`, including `JetBrains.Annotations`, `Microsoft.Extensions.Logging.Abstractions`, `System.IO.Abstractions`, and `Wcwidth`. Refactored methods in `RuneExtensions.cs`: - Simplified `GetColumns` by removing special Unicode handling. - Renamed constants to follow naming conventions. - Improved logic and readability in `DecodeSurrogatePair`, `Encode`, and `GetEncodingLength`. - Streamlined `IsSurrogatePair` and `MakePrintable` for clarity and efficiency. * Update package version ranges for flexibility Updated the `JetBrains.Annotations` package to use a version range starting from `2025.2.2` to allow future updates. Adjusted the `Microsoft.Extensions.Logging.Abstractions` package to a version range `[9.0.0,10)` for compatibility. Changed `System.IO.Abstractions` to a range `[22.0.16,23)` and `Wcwidth` to `[3.0.0,)` to enable future updates within specified ranges. * 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 `` section in `RuneExtensions.GetColumns` to include details about the `wcwidth` implementation and improved readability with `` 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 `` 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 Co-authored-by: Thomas Nind <31306100+tznind@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix nit test. * Change ClearScreenNextIteration to internal and trying to fix unit test failure * Reuse method and fix text field color to normal, probably due some changed configuration * Fix scenario Shortcut not restoring Application.Quit * Giving more time to load Scrolling scenario and display failing scenario * Revert changes and add more assertions * Forcing CI tests again and I suspect that is causing by UpdateFromJson unit test * Changed test to force fake driver * Ensure restore the original colors * Fix ResetToHardCodedDefaults method * Tested with this before and the tests pass * Revert "Tested with this before and the tests pass" This reverts commit 297b88536c4197d5dac056073d9c622bd17c4fba. * Revert "Fix ResetToHardCodedDefaults method" This reverts commit 3a28c5e945ea71c6cb7d65221b067423a14ce8ca. * Trying to fix scenario tests --------- Co-authored-by: Tig Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: tig <585482+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> --- .../UICatalog/Scenarios/CombiningMarks.cs | 2 +- Examples/UICatalog/Scenarios/Shortcuts.cs | 2 ++ Terminal.Gui/App/Application.Screen.cs | 4 +-- .../Drivers/WindowsDriver/WindowsOutput.cs | 28 ++++++++++++++++--- Terminal.Gui/ViewBase/View.Layout.cs | 22 +++++++++++++-- Terminal.Gui/ViewBase/View.cs | 2 +- .../UICatalog/ScenarioTests.cs | 19 ++++++++----- .../Application/ApplicationScreenTests.cs | 16 ++++++++++- .../Application/SynchronizatonContextTests.cs | 2 +- .../Configuration/ConfigurationMangerTests.cs | 2 -- Tests/UnitTests/Views/ComboBoxTests.cs | 4 ++- 11 files changed, 80 insertions(+), 23 deletions(-) diff --git a/Examples/UICatalog/Scenarios/CombiningMarks.cs b/Examples/UICatalog/Scenarios/CombiningMarks.cs index 6e0467ce0..7d8437a23 100644 --- a/Examples/UICatalog/Scenarios/CombiningMarks.cs +++ b/Examples/UICatalog/Scenarios/CombiningMarks.cs @@ -13,7 +13,7 @@ public class CombiningMarks : Scenario top.DrawComplete += (s, e) => { // Forces reset _lineColsOffset because we're dealing with direct draw - Application.ClearScreenNextIteration = true; + Application.Top!.SetNeedsDraw (); var i = -1; top.AddStr ("Terminal.Gui only supports combining marks that normalize. See Issue #2616."); diff --git a/Examples/UICatalog/Scenarios/Shortcuts.cs b/Examples/UICatalog/Scenarios/Shortcuts.cs index 73ec7a5dd..c96dccd7c 100644 --- a/Examples/UICatalog/Scenarios/Shortcuts.cs +++ b/Examples/UICatalog/Scenarios/Shortcuts.cs @@ -12,6 +12,7 @@ public class Shortcuts : Scenario public override void Main () { Application.Init (); + var quitKey = Application.QuitKey; Window app = new (); app.Loaded += App_Loaded; @@ -19,6 +20,7 @@ public class Shortcuts : Scenario Application.Run (app); app.Dispose (); Application.Shutdown (); + Application.QuitKey = quitKey; } // Setting everything up in Loaded handler because we change the diff --git a/Terminal.Gui/App/Application.Screen.cs b/Terminal.Gui/App/Application.Screen.cs index cc9dcb0b6..1ceed1d7c 100644 --- a/Terminal.Gui/App/Application.Screen.cs +++ b/Terminal.Gui/App/Application.Screen.cs @@ -82,8 +82,8 @@ public static partial class Application // Screen related stuff /// Gets or sets whether the screen will be cleared, and all Views redrawn, during the next Application iteration. /// /// - /// This is typicall set to true when a View's changes and that view has no + /// This is typical set to true when a View's changes and that view has no /// SuperView (e.g. when is moved or resized. /// - public static bool ClearScreenNextIteration { get; set; } + internal static bool ClearScreenNextIteration { get; set; } } diff --git a/Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs b/Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs index 4c14cd6ed..6c5f806c7 100644 --- a/Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs +++ b/Terminal.Gui/Drivers/WindowsDriver/WindowsOutput.cs @@ -100,6 +100,8 @@ internal partial class WindowsOutput : OutputBase, IConsoleOutput private readonly nint _outputHandle; private nint _screenBuffer; private readonly bool _isVirtualTerminal; + private readonly ConsoleColor _foreground; + private readonly ConsoleColor _background; public WindowsOutput () { @@ -117,8 +119,16 @@ internal partial class WindowsOutput : OutputBase, IConsoleOutput if (_isVirtualTerminal) { - //Enable alternative screen buffer. - Console.Out.Write (EscSeqUtils.CSI_SaveCursorAndActivateAltBufferNoBackscroll); + if (Environment.GetEnvironmentVariable ("VSAPPIDNAME") is null) + { + //Enable alternative screen buffer. + Console.Out.Write (EscSeqUtils.CSI_SaveCursorAndActivateAltBufferNoBackscroll); + } + else + { + _foreground = Console.ForegroundColor; + _background = Console.BackgroundColor; + } } else { @@ -502,8 +512,18 @@ internal partial class WindowsOutput : OutputBase, IConsoleOutput if (_isVirtualTerminal) { - //Disable alternative screen buffer. - Console.Out.Write (EscSeqUtils.CSI_RestoreCursorAndRestoreAltBufferWithBackscroll); + if (Environment.GetEnvironmentVariable ("VSAPPIDNAME") is null) + { + //Disable alternative screen buffer. + Console.Out.Write (EscSeqUtils.CSI_RestoreCursorAndRestoreAltBufferWithBackscroll); + } + else + { + // Simulate restoring the color and clearing the screen. + Console.ForegroundColor = _foreground; + Console.BackgroundColor = _background; + Console.Clear (); + } } else { diff --git a/Terminal.Gui/ViewBase/View.Layout.cs b/Terminal.Gui/ViewBase/View.Layout.cs index 8f28cdba2..72bb409b3 100644 --- a/Terminal.Gui/ViewBase/View.Layout.cs +++ b/Terminal.Gui/ViewBase/View.Layout.cs @@ -239,6 +239,8 @@ public partial class View // Layout APIs _x = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (X)} cannot be null"); PosDimSet (); + + NeedsClearScreenNextIteration (); } } @@ -281,6 +283,8 @@ public partial class View // Layout APIs _y = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (Y)} cannot be null"); PosDimSet (); + + NeedsClearScreenNextIteration (); } } @@ -339,6 +343,8 @@ public partial class View // Layout APIs OnHeightChanged, HeightChanged, out Dim _); + + NeedsClearScreenNextIteration (); } } @@ -425,6 +431,17 @@ public partial class View // Layout APIs OnWidthChanged, WidthChanged, out Dim _); + + NeedsClearScreenNextIteration (); + } + } + + private void NeedsClearScreenNextIteration () + { + if (Application.Top is { } && Application.Top == this && Application.TopLevels.Count == 1) + { + // If this is the only TopLevel, we need to redraw the screen + Application.ClearScreenNextIteration = true; } } @@ -653,10 +670,9 @@ public partial class View // Layout APIs { SuperView?.SetNeedsDraw (); } - else if (Application.TopLevels.Count == 1) + else { - // If this is the only TopLevel, we need to redraw the screen - Application.ClearScreenNextIteration = true; + NeedsClearScreenNextIteration (); } } diff --git a/Terminal.Gui/ViewBase/View.cs b/Terminal.Gui/ViewBase/View.cs index 3edf1e768..27c0780f7 100644 --- a/Terminal.Gui/ViewBase/View.cs +++ b/Terminal.Gui/ViewBase/View.cs @@ -378,7 +378,7 @@ public partial class View : IDisposable, ISupportInitializeNotification } else { - Application.ClearScreenNextIteration = true; + NeedsClearScreenNextIteration (); } } } diff --git a/Tests/IntegrationTests/UICatalog/ScenarioTests.cs b/Tests/IntegrationTests/UICatalog/ScenarioTests.cs index 7fa654e9e..12517df84 100644 --- a/Tests/IntegrationTests/UICatalog/ScenarioTests.cs +++ b/Tests/IntegrationTests/UICatalog/ScenarioTests.cs @@ -41,8 +41,9 @@ public class ScenarioTests : TestsAllViews _output.WriteLine ($"Running Scenario '{scenarioType}'"); var scenario = Activator.CreateInstance (scenarioType) as Scenario; + var scenarioName = scenario!.GetName (); - uint abortTime = 2000; + uint abortTime = 2200; object? timeout = null; var initialized = false; var shutdownGracefully = false; @@ -70,7 +71,7 @@ public class ScenarioTests : TestsAllViews Assert.True (initialized); - Assert.True (shutdownGracefully, $"Scenario Failed to Quit with {quitKey} after {abortTime}ms and {iterationCount} iterations. Force quit."); + Assert.True (shutdownGracefully, $"Scenario '{scenarioName}' Failed to Quit with {quitKey} after {abortTime}ms and {iterationCount} iterations. Force quit."); #if DEBUG_IDISPOSABLE Assert.Empty (View.Instances); @@ -91,11 +92,6 @@ public class ScenarioTests : TestsAllViews { Application.Iteration += OnApplicationOnIteration; initialized = true; - - lock (_timeoutLock) - { - timeout = Application.AddTimeout (TimeSpan.FromMilliseconds (abortTime), ForceCloseCallback); - } } else { @@ -126,6 +122,15 @@ public class ScenarioTests : TestsAllViews void OnApplicationOnIteration (object? s, IterationEventArgs a) { + if (iterationCount == 0) + { + // Start the timeout countdown on the first iteration + lock (_timeoutLock) + { + timeout = Application.AddTimeout (TimeSpan.FromMilliseconds (abortTime), ForceCloseCallback); + } + } + iterationCount++; if (Application.Initialized) diff --git a/Tests/UnitTests/Application/ApplicationScreenTests.cs b/Tests/UnitTests/Application/ApplicationScreenTests.cs index 0086cb01b..675b683ad 100644 --- a/Tests/UnitTests/Application/ApplicationScreenTests.cs +++ b/Tests/UnitTests/Application/ApplicationScreenTests.cs @@ -47,7 +47,7 @@ public class ApplicationScreenTests Assert.Equal (0, clearedContentsRaised); // Act - Application.Top.SetNeedsLayout (); + Application.Top!.SetNeedsLayout (); Application.LayoutAndDraw (); // Assert @@ -67,6 +67,20 @@ public class ApplicationScreenTests // Assert Assert.Equal (2, clearedContentsRaised); + // Act + Application.Top.Y = 1; + Application.LayoutAndDraw (); + + // Assert + Assert.Equal (3, clearedContentsRaised); + + // Act + Application.Top.Height = 10; + Application.LayoutAndDraw (); + + // Assert + Assert.Equal (4, clearedContentsRaised); + Application.End (rs); return; diff --git a/Tests/UnitTests/Application/SynchronizatonContextTests.cs b/Tests/UnitTests/Application/SynchronizatonContextTests.cs index 6546692df..e049dcb03 100644 --- a/Tests/UnitTests/Application/SynchronizatonContextTests.cs +++ b/Tests/UnitTests/Application/SynchronizatonContextTests.cs @@ -10,7 +10,7 @@ public class SyncrhonizationContextTests public void SynchronizationContext_CreateCopy () { ConsoleDriver.RunningUnitTests = true; - Application.Init (); + Application.Init (null, "fake"); SynchronizationContext context = SynchronizationContext.Current; Assert.NotNull (context); diff --git a/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs b/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs index 4e0774f1f..77ac743c0 100644 --- a/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs +++ b/Tests/UnitTests/Configuration/ConfigurationMangerTests.cs @@ -1010,8 +1010,6 @@ public class ConfigurationManagerTests (ITestOutputHelper output) finally { Disable (resetToHardCodedDefaults: true); - } } - } diff --git a/Tests/UnitTests/Views/ComboBoxTests.cs b/Tests/UnitTests/Views/ComboBoxTests.cs index 9466b47fb..a8caab2c7 100644 --- a/Tests/UnitTests/Views/ComboBoxTests.cs +++ b/Tests/UnitTests/Views/ComboBoxTests.cs @@ -525,7 +525,9 @@ public class ComboBoxTests (ITestOutputHelper output) Assert.True (cb.IsShow); Assert.Equal (-1, cb.SelectedItem); Assert.Equal ("", cb.Text); - + Assert.False (Application.ClearScreenNextIteration); + Assert.True (cb.NeedsLayout); + Assert.True (cb.NeedsDraw); cb.Layout (); cb.Draw ();