You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixes#4274 - v2win vsdebugconsole issue CM related UnitTest failures (#4287)
* 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 <[email protected]>
* Extract Windows key helper utilities and fix build
Co-authored-by: tig <[email protected]>
* Fix all test references to legacy drivers
Co-authored-by: tig <[email protected]>
* Update documentation to reflect new driver architecture
Co-authored-by: tig <[email protected]>
* Remove V2.cd diagram file
Co-authored-by: tig <[email protected]>
* Fix test failures: support legacy drivers and update exception handling
Co-authored-by: tig <[email protected]>
* updated driver names
* Move V2 tests from ConsoleDrivers/V2 to proper locations
Co-authored-by: tig <[email protected]>
* Rename ApplicationV2 to ModernApplicationImpl to remove v2 terminology
Co-authored-by: tig <[email protected]>
* Remove V2 terminology from test drivers and FakeDriver classes
Co-authored-by: tig <[email protected]>
* Merge ModernApplicationImpl into ApplicationImpl and move to App folder
Co-authored-by: tig <[email protected]>
* Create modern FakeDriver with component factory architecture in Terminal.Gui project
Co-authored-by: tig <[email protected]>
* Refactor: Move non-platform-dependent code from /Drivers to /App
Co-authored-by: tig <[email protected]>
* Code cleanup and org
* Unit test reorg
* Refactor MainLoop architecture: rename classes and enhance documentation for clarity
Co-authored-by: tig <[email protected]>
* Add comprehensive FakeDriver tests (WIP - some tests need fixes)
Co-authored-by: tig <[email protected]>
* Fixed FakeDriver build failures
* Fix all FakeDriver test failures - Application.Top creation and clipboard behaviors
Co-authored-by: tig <[email protected]>
* Fixed FakeDriver build failures2
* Remove hanging legacy FakeDriver tests that use Console.MockKeyPresses
Co-authored-by: tig <[email protected]>
* Fixed some tests
* Fixed more tests
* Fixed more tests
* Fix bad copilot (#4277)
* Update Terminal.Gui/Drivers/FakeDriver/FakeConsoleOutput.cs
Co-authored-by: Copilot <[email protected]>
* 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] <[email protected]>
Co-authored-by: tig <[email protected]>
Co-authored-by: Tig <[email protected]>
Co-authored-by: Thomas Nind <[email protected]>
Co-authored-by: Copilot <[email protected]>
* 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
* Update test runner behavior in unit-tests.yml
Changed `fail-fast` to `false` in `non_parallel_unittests` to allow all runners to complete even if errors occur. Updated `xunit.stopOnFail` to `true` in both `Run UnitTests` and `Run UnitTestsParallelizable` steps to stop test execution immediately upon failure. These changes improve test handling and execution consistency.
Refactor and enhance configuration and scheme handling
Refactored `ConfigurationManager` and `Scope<T>` to improve clarity and ensure proper resetting to hardcoded defaults. Updated `Color` constructor to use ARGB values for accuracy. Added debug assertions and logging for better test reliability.
Expanded test coverage:
- Verified hardcoded schemes and themes reset correctly.
- Added tests for `UpdateFromJson` behavior and `Color.ToString` output.
- Improved `SchemeManager` and `SchemeTests` to validate attributes and scheme overrides.
General improvements include better state management during tests and enhanced readability of event handlers.
* Found cause of #4288 and provided a workaround
* Reverted unneeded change to ComboBoxTests
* Fixed test that wasn't actually testing anything
* Added more precise unit test showing issue
* Added more precise unit test showing issue2
* Made test even more precise
* Potential fix for underlying issue
* Fixed test that broke with last change
* Reverted`ConfigurationManager` to return `_hardCodedConfigPropertyCache` directly, eliminating deep copy overhead for better performance.
Added a new test in `ConfigurationManagerTests` to verify that `GetHardCodedConfigPropertyCache` always returns the same reference. Updated existing tests to reflect this change.
Refactored `SchemeManagerTests` to use `try-finally` blocks for proper cleanup and improved test reliability. Applied similar changes to other test methods for consistency.
Re-enabled the `UpdateFrom_Corrupts_Schemes_HardCodeDefaults` test in `ThemeScopeTests` as the underlying issue has been rnot been esolved.
* Updated the `Disable` method calls across test classes to use
the new overload with a `true` parameter, ensuring consistent
behavior.
* Refactor and fix configuration and theme management
Refactored method names across multiple classes for clarity and consistency (e.g., `LoadCurrentValues` to `UpdateToCurrentValues`, `ResetToHardCodedDefaults` to `LoadHardCodedDefaults`). Removed redundant attributes from `ConfigurationManager`.
Implemented a workaround for `SchemeManager` to address issues with hard-coded schemes being overwritten. Updated `ThemeManager` logic to ensure proper initialization and updates of themes.
Aligned unit tests with refactored methods and added comments to document changes. Made minor adjustments to improve code maintainability, including handling of property values and removal of unused variables.
* Fix hard-coded defaults corruption in ThemeScope
Replaced `ResetToCurrentValues` with `ResetToHardCodedDefaults` across multiple files to address corruption of hard-coded defaults.
- Added a partial workaround in `ConfigurationManager.cs` to prevent overwriting hard-coded schemes in `ThemeScope`.
- Highlighted known issues with `UpdateToCurrentValues` in `ThemeManager.cs`.
- Updated tests in `ConfigurationManagerTests`, `SchemeManagerTests`, and others to reflect the reset method.
- Skipped or modified tests that rely on `ResetToCurrentValues` due to its corruption issues.
- Refactored `GlyphTests` to ensure proper cleanup using `try-finally`.
- Added comments and skipped tests to document and work around known bugs (e.g., #4288).
* Clarify comments and add theme reset functionality
Updated comments in `SchemeManager` and `ThemeManager` to clarify that the workaround for hardcoded schemes is partial.
Added a new `LoadHardCodedDefaults` method to `ThemeManager`, marked with `[RequiresUnreferencedCode]` and `[RequiresDynamicCode]`, to reset themes to hardcoded defaults. This method ensures proper initialization by throwing an exception if `ConfigurationManager` is not initialized.
Updated `ThemeManager` to call `SchemeManager.LoadToHardCodedDefaults` during the theme reset process, ensuring consistent loading of hardcoded schemes.
* Removed special handling for the "Schemes" key in `hardCodedThemeProperties`,
* Code cleanup
Refactored XML documentation comments for better readability.
Enhanced exception handling in `GetScheme(Schemes)` by adding a null check and throwing `ArgumentException` for invalid inputs.
Simplified method definitions by converting multi-line methods to single-line.
Updated attributes for `LoadToHardCodedDefaults` to align with the `SetSchemes` method.
Refactored `LoadToHardCodedDefaults` implementation for cleaner code.
Added support for Visual Studio debug console in `WindowsDriver`, including disabling the alternative screen buffer, preserving original console colors, and restoring them on shutdown.
Performed general code cleanup, including removing unnecessary comments and improving inline comments for clarity.
* Refactor and remove redundant validation methods
Removed `Validate` methods from `ConfigurationManager`, `Scope<T>`, and `ThemeManager`, indicating a shift in validation responsibilities. Enabled nullable reference types in `Scope.cs` to enforce stricter nullability checks. Simplified `Scope<T>` constructor and replaced explicit type declarations with `var` for improved readability. Adjusted LINQ query formatting and removed unused `using System.Text.Json;` to clean up dependencies. Made minor formatting changes for consistency and maintainability.
* Refactor ConfigurationManager for clarity and safety
Renamed `ResetToCurrentValues` to `UpdateToCurrentValues` for better clarity and updated all references, including comments and documentation. Introduced `_hardCodedConfigPropertyCacheLock` to ensure thread-safety when accessing `_hardCodedConfigPropertyCache`. Updated `Reset` terminology to `Update` across the codebase to reflect the updated behavior.
Improved `SerializerContext` initialization with concise syntax and fixed a formatting issue in a `Console.WriteLine` statement. Reformatted filtering logic for `configPropertiesByScope` for better readability.
Updated test cases in `AppSettingsScopeTests` and `ConfigurationManagerTests` to align with the renamed method and ensure consistent functionality.
* Code cleanup
Improve readability and handle null in serialization
Refactored LINQ queries to remove redundant line breaks, improving code readability. Updated comments for clarity and adjusted tone. Added a null check for the `prop` variable during serialization to ensure proper handling of null values by writing `null` to the JSON writer.
* Code Cleanup - Refactor ThemeManager and improve nullability handling
Updated ThemeManager to improve method visibility, naming consistency, and documentation. Introduced `GetHardCodedThemes` and `SetThemes` for better encapsulation. Made `DEFAULT_THEME_NAME` public for broader access. Enhanced nullability handling across multiple files using the null-forgiving operator (`!`) to suppress warnings.
Refactored `Themes.cs` to ensure proper cleanup of `allViewsView`. Simplified assertions in test files to reflect updated method visibility and removed redundant checks. Improved code clarity and maintainability throughout the codebase.
---------
Co-authored-by: BDisp <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: tig <[email protected]>
Co-authored-by: Thomas Nind <[email protected]>
Co-authored-by: Copilot <[email protected]>
Copy file name to clipboardExpand all lines: Terminal.Gui/Configuration/SchemeManager.cs
+25-15Lines changed: 25 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -7,25 +7,29 @@
7
7
namespaceTerminal.Gui.Configuration;
8
8
9
9
/// <summary>
10
-
/// Holds the <see cref="Drawing.Scheme"/>s that define the <see cref="System.Attribute"/>s that are used by views to render
11
-
/// themselves. A Scheme is a mapping from <see cref="Drawing.VisualRole"/>s (such as <see cref="Drawing.VisualRole.Focus"/>) to <see cref="System.Attribute"/>s.
10
+
/// Holds the <see cref="Drawing.Scheme"/>s that define the <see cref="System.Attribute"/>s that are used by views to
11
+
/// render
12
+
/// themselves. A Scheme is a mapping from <see cref="Drawing.VisualRole"/>s (such as
13
+
/// <see cref="Drawing.VisualRole.Focus"/>) to <see cref="System.Attribute"/>s.
12
14
/// A Scheme defines how a `View` should look based on its purpose (e.g. Menu or Dialog).
0 commit comments