SIGN IN SIGN UP
gui-cs / Terminal.Gui UNCLAIMED

Cross Platform Terminal UI toolkit for .NET

0 0 0 C#
2024-07-28 12:23:09 +01:00
This is a sample app that shows how to use `System.Reactive` and `ReactiveUI` with `Terminal.Gui`. The app uses the MVVM architecture that may seem familiar to folks coming from WPF, Xamarin Forms, UWP, Avalonia, or Windows Forms. In this app, we implement the data bindings using ReactiveUI `WhenAnyValue` syntax and [ObservableEvents](https://github.com/reactivemarbles/ObservableEvents) — a Source Generator that turns events into observable wrappers.
2020-10-01 12:45:38 +03:00
<img src="https://user-images.githubusercontent.com/6759207/94748621-646a7280-038a-11eb-8ea0-34629dc799b3.gif" width="450">
2020-10-01 13:42:21 +03:00
### Scheduling
In order to use reactive extensions scheduling, copy-paste the `TerminalScheduler.cs` file into your project, and add the following lines to the composition root of your `Terminal.Gui` application:
```cs
Fixes #4419, #4148, #4408 - Toplevel is GONE - Replaced by Runnable (#4422) * WIP: Broken * Got working. Mostly. * Parllel tests pass * More progres * Fixed app tests. * Mouse * more progress. * working on shortcut * Shortcut accept on ENTER is broken. * One left... * More test progress. * All unit tests pass. Still some issues though. * tweak * Fixed Integration Tests * Fixed UI Catalog * Tweaking CP to try to find race condition * Refactor StandardColors and improve ColorPicker logic Refactored `StandardColors` to use lazy initialization for static fields, improving performance and avoiding static constructor convoy effects. Introduced `NamesValueFactory` and `MapValueFactory` methods for encapsulated initialization logic. Simplified `GetColorNames` to directly return `_names.Value`. Improved `TryParseColor` by clarifying default value usage and adopting object initializer syntax. Updated `TryNameColor` to use `_argbNameMap.Value`. Refactored `GetArgb` for better readability. Replaced `MultiStandardColorNameResolver` with `StandardColorsNameResolver` in `ColorPicker`. Commented out `app.Init("Fake")` in `ColorPickerTests` for testing purposes. Made minor formatting improvements, including updated comments and XML documentation for consistency. * revert * Throttle input loop to prevent CPU spinning Introduce a 20ms delay in the input loop of `InputImpl<TInputRecord>` to prevent excessive CPU usage when no input is available. Removed the `DateTime dt = Now();` line and the `while (Peek())` block, which previously enqueued input records. This change improves resource management, especially in scenarios where multiple `ApplicationImpl` instances are created in parallel tests without calling `Shutdown()`. It prevents thread pool exhaustion and ensures better performance in such cases. * Refactor ApplicationImpl to use IDisposable pattern Implemented the IDisposable pattern in ApplicationImpl to improve resource management. Added `Dispose` and `DisposeCore` methods, and marked the `Shutdown` method as obsolete, encouraging the use of `Dispose` or `using` statements instead. Updated the `IApplication` interface to inherit from IDisposable and added `GetResult` methods for retrieving run session results. Refactored unit tests to adopt the new lifecycle management approach, replacing legacy `Shutdown` calls with `Dispose` or `using`. Removed fragile and obsolete tests, and re-enabled previously skipped tests after addressing underlying issues. Updated `FakeApplicationLifecycle` and `SetupFakeApplicationAttribute` to align with the new disposal pattern. Improved documentation and examples to guide users toward modern usage patterns. Maintained backward compatibility for legacy singleton usage. * Add IDisposable pattern with input loop throttling - Add IDisposable to IApplication for proper resource cleanup - Add 20ms throttle to input loop (prevents CPU spinning) - Add Lazy<T> to StandardColors (eliminates convoy effect) - Add MainLoopCoordinatorTests suite (5 new tests) - Add Dispose() calls to all 16 ColorPickerTests - Mark Application.Shutdown() as [Obsolete] IApplication now requires Dispose() for cleanup Performance: 100x CPU reduction, 15x faster disposal, tests complete in <5s Fixes: Thread leaks, CPU saturation, test hangs in parallel execution Docs: Updated application.md and newinv2.md with disposal patterns * Refactor test for input loop throttling clarity Updated `InputLoop_Throttle_Limits_Poll_Rate` test to improve clarity, reliability, and efficiency: - Rewrote summary comment to clarify purpose and emphasize the 20ms throttle's role in preventing CPU spinning. - Replaced `var` with explicit types for better readability. - Reduced test duration from 1s to 500ms to improve test speed. - Revised assertions: - Replaced range-based assertion with upper-bound check to ensure poll count is below 500, avoiding timing sensitivity issues. - Added assertion to verify the thread ran and was not immediately canceled. - Added a 2-second timeout to `inputTask.Wait` and verified task completion. - Improved comments to explain test behavior and reasoning behind changes. * tweaks * Fix nullabiltiy stuff. * runnable fixes * more nullabe * More nullability * warnings gone * Fixed fluent test failure. * Refactor ApplicationImpl and update Runnable layout logic Refactored `ApplicationImpl.Run.cs` for improved readability and atomicity: - Combined `if (wasModal)` with `SessionStack?.TryPop` to streamline logic. - Simplified restoration of `previousRunnable` by reducing nesting. - Updated comments for clarity and retained `SetIsModal` call. Simplified focus-setting logic in `ApplicationImpl.Run.cs` using pattern matching for `TopRunnableView`. In `Runnable<TResult>`, added `SetNeedsLayout` after `IsModalChanged` to ensure layout updates. Removed an unused empty line for cleanup. Corrected namespace in `GetViewsUnderLocationForRootTests.cs` to align with test structure. * Update layout on modal state change A call to `SetNeedsLayout()` was added to the `OnIsModalChanged` method in the `Runnable` class. This ensures that the layout is updated whenever the modal state changes. * Increase test timeout for inputTask.Wait to 10 seconds Extended the timeout duration for the `inputTask.Wait` method from 4 seconds to 10 seconds in `MainLoopCoordinatorTests`. This change ensures the test has a longer window to complete under conditions of increased load or slower execution environments, reducing the likelihood of false test failures. * Refactor project files and simplify test logic Removed `<LangVersion>` and `<ImplicitUsings>` properties from `UnitTests.csproj` and `UnitTests.Parallelizable.csproj` to rely on default SDK settings and disable implicit global usings. Simplified the `SizeChanged_Event_Still_Fires_For_Compatibility` test in `FakeDriverTests` by removing the `screenChangedFired` variable, its associated event handler, and related assertions. Also removed obsolete warning suppression directives as they are no longer needed. * Reduce UnitTestsParallelizable iterations from 10 to 3 Reduced the number of iterations for the UnitTestsParallelizable test suite from 10 to 3 to save time and resources while still exposing concurrency issues. Updated the loop and log messages to reflect the new iteration count. * disabled InputLoop_Throttle_Limits_Poll_Rate * Refactor app lifecycle and improve Runnable API Refactored `Program.cs` to simplify application lifecycle: - Modularized app creation, initialization, and disposal. - Improved result handling and ensured proper resource cleanup. Re-implemented `Runnable<TResult>` with a cleaner design: - Retained functionality while improving readability and structure. - Added XML documentation and followed the Cancellable Work Pattern. Re-implemented `RunnableWrapper<TView, TResult>`: - Enabled wrapping any `View` to make it runnable with typed results. - Added examples and remarks for better developer guidance. Re-implemented `ViewRunnableExtensions`: - Provided fluent API for making views runnable with or without results. - Enhanced documentation with examples for common use cases. General improvements: - Enhanced code readability, maintainability, and error handling. - Replaced redundant code with cleaner, more maintainable versions. * Modernize codebase for Terminal.Gui and MVVM updates Refactored `LoginView` to remove redundant `Application.LayoutAndDraw()` call. Enhanced `LoginViewModel` with new observable properties for automatic property change notifications. Updated `Message` class to use nullable generics for improved type safety. Replaced legacy `Application.Init()` and `Application.Run()` calls with the modern `IApplication` API across `Program.cs`, `Example.cs`, and `ReactiveExample`. Ensured proper disposal of `IApplication` instances to prevent resource leaks. Updated `TerminalScheduler` to integrate with `IApplication` for invoking actions and managing timeouts. Added null checks and improved timeout disposal logic for robustness. Refactored `ExampleWindow` for better readability and alignment with modern `Terminal.Gui` conventions. Cleaned up unused imports and improved code clarity across the codebase. Updated README.md to reflect the latest `Terminal.Gui` practices, including examples of the `IApplication` API and automatic UI refresh handling. Renamed `LoginAction` to `LoginActions` for consistency. * Refactor: Transition to IRunnable-based architecture Replaced `Toplevel` with `Window` as the primary top-level UI element. Introduced the `IRunnable` interface to modernize the architecture, enabling greater flexibility and testability. Deprecated the static `Application` class in favor of the instance-based `IApplication` model, which supports multiple application contexts. Updated methods like `Application.Run()` and `Application.RequestStop()` to use `IRunnable`. Removed or replaced legacy `Modal` properties with `IsModal`. Enhanced the `IApplication` interface with a fluent API, including methods like `Run<TRunnable>()` and `GetResult<T>()`. Refactored tests and examples to align with the new architecture. Updated documentation to reflect the instance-based model. Deprecated obsolete members and methods, including `Application.Current` and `Application.TopRunnable`. Improved event handling by replacing the `Accept` event with `Accepting` and using `e.Handled` for event processing. Updated threading examples to use `App?.Invoke()` or `app.Invoke()` for UI updates. Cleaned up redundant code and redefined modal behavior for better consistency. These changes modernize the `Terminal.Gui` library, improving clarity, usability, and maintainability while ensuring backward compatibility where possible. * Refactor: Replace Toplevel with Runnable class This commit introduces a major architectural update to the `Terminal.Gui` library, replacing the legacy `Toplevel` class with the new `Runnable` class. The changes span the entire codebase, including core functionality, tests, documentation, and configuration files. - **Core Class Replacement**: - Replaced `Toplevel` with `Runnable` as the base class for modal views and session management. - Updated all references to `Toplevel` in the codebase, including constructors, methods, and properties. - **Configuration Updates**: - Updated `tui-config-schema.json` to reflect the new `Runnable` scheme. - **New Classes**: - Added `UICatalogRunnable` for managing the UI Catalog application. - Introduced `Runnable<TResult>` as a generic base class for blocking sessions with result handling. - **Documentation and Tests**: - Updated documentation to emphasize `Runnable` and mark `Toplevel` as obsolete. - Refactored test cases to use `Runnable` and ensure compatibility. - **Behavioral Improvements**: - Enhanced lifecycle management and alignment with the `IRunnable` interface. - Improved clarity and consistency in naming conventions. These changes modernize the library, improve flexibility, and provide a clearer architecture for developers. * Refactor: Consolidate Runnable classes and decouple View from ApplicationImpl - Made Runnable<TResult> inherit from Runnable (eliminating ~180 LOC duplication) - Moved View init/layout/cursor logic from ApplicationImpl to Runnable lifecycle events - ApplicationImpl.Begin now operates purely on IRunnable interface Related to #4419 * Simplified the disposal logic in `ApplicationImpl.Run.cs` by replacing the type-specific check for `View` with a more general check for `IDisposable`. This ensures proper disposal of any `IDisposable` object, improving robustness. Removed the `FrameworkOwnedRunnable` property from the `ApplicationImpl` class in `ApplicationImpl.cs` and the `IApplication` interface in `IApplication.cs`. This eliminates the need to manage this property, reducing complexity and improving maintainability. Updated `application.md` to reflect the removal of the `FrameworkOwnedRunnable` property, ensuring the documentation aligns with the updated codebase. * Replaces the legacy `Shutdown()` method with `Dispose()` to align with the `IDisposable` pattern, ensuring proper resource cleanup and simplifying the API. The `Dispose()` method is now the recommended way to release resources, with `using` statements encouraged for automatic disposal. Key changes: - Marked `Shutdown()` as obsolete; it now internally calls `Dispose()`. - Updated the fluent API to remove `Shutdown()` from chaining. - Enhanced session lifecycle management for thread safety. - Updated tests to validate proper disposal and state reset. - Improved `IRunnable` integration with automatic disposal for framework-created runnables. - Maintained backward compatibility for the legacy static `Application` singleton. - Refactored documentation and examples to reflect modern practices and emphasize `Dispose()` usage. These changes modernize the `Terminal.Gui` lifecycle, improve testability, and encourage alignment with .NET conventions. * Refactor runnable app context handling in ApplicationImpl Refactor how the application context is set for `runnable` objects by introducing a new `SetApp` method in the `IRunnable` interface. This replaces the previous logic of directly setting the `App` property for `View` objects, making the process more generic and encapsulated within `IRunnable` implementations. Simplify `Mouse.UngrabMouse()` by removing the conditional check and calling it unconditionally. Make a minor formatting adjustment in the generic constraint of `Run<TRunnable>` in `ApplicationImpl`. Add `SetApp(IApplication app)` to the `IRunnable` interface and implement it in the `Runnable` class to set the `App` property to the provided application instance. * Improve docs, tests, and modularity across the codebase Reorganized and updated `CONTRIBUTING.md`: - Added **Key Architecture Concepts** section and reordered the table of contents. - Updated testing requirements to discourage legacy patterns. - Added instructions for replicating CI workflows locally. - Clarified PR guidelines and coding style expectations. Enhanced `README.md` with detailed CI/CD workflow documentation. Refactored `ColorPicker.Prompt` to use `IApplication` for improved modularity and testability. Introduced `IApplicationScreenChangedTests` for comprehensive testing of `ScreenChanged` events and `Screen` property. Refactored `ApplicationScreenTests` and `TextView.PromptForColors` to align with modern patterns. Updated `Terminal.sln` to include `.github/workflows/README.md`. Performed general cleanup: - Removed outdated documentation links. - Improved XML documentation and coding consistency. * readme tweaks * Improve thread safety, layout, and test coverage Refactored `OutputBufferImpl.cs` to enhance thread safety by locking shared resources and adding bounds checks for columns and rows. Improved handling of wide characters and removed outdated TODO comments. Updated `Runnable.cs` to call `SetNeedsDraw()` on modal state changes, ensuring proper layout and drawing updates. Simplified layout handling in `ApplicationImpl.Run.cs` by replacing redundant comments with a `LayoutAndDraw()` call. Added a check in `AllViewsTester.cs` to skip creating instances of `RunnableWrapper` types with unsatisfiable generic constraints, logging a warning when encountered. Enhanced `ListViewTests.cs` by adding explicit `app.LayoutAndDraw()` calls to validate visual output and ensure tests reflect the updated application state. These changes improve robustness, prevent race conditions, and ensure consistent behavior across the application. * Refactor: Rename Toplevel to Runnable and update logic Updated the `Border` class to use `Command.Quit` instead of `Command.QuitToplevel` in the `CloseButton.Accept` handler. Renamed test methods in `GetViewsAtLocationTests.cs` to replace "Toplevel" with "Runnable" for consistency. Updated `Runnable<bool>` instances to use "topRunnable" as the `Id` property. These changes align the codebase with updated naming conventions and improve clarity. * Removed `ToplevelTests` and migrated relevant test cases to `MouseDragTests` with improved structure and coverage. Updated tests to use `Application.Create`, `app.Begin`, and `app.End` for better resource management and lifecycle handling. Replaced direct event handling with `app.Mouse.RaiseMouseEvent` to align with the application's event-handling mechanism. Added `Runnable` objects to ensure views are properly initialized and disposed of within the application context. Enhanced tests to include assertions for minimum width and height constraints during resize operations. Removed redundant tests and streamlined logic to reduce duplication and improve maintainability. * Reorged Unit Test namespaces. * more * Refactor tests and update namespaces for consistency Updated namespaces in `ArrangementTests.cs` and `MouseDragTests.cs` for better organization. Enhanced `ArrangementTests.cs` with additional checks for arrangement flags. Reformatted and re-added `MouseDragTests.cs` and `SchemeTests.cs` with modern C# features like nullable annotations and object initializers. Ensured no functional changes while improving code clarity and consistency. * Fix nullability warnings in MouseDragTests.cs Updated `app.End` calls to use the null-forgiving operator (`!`) on `app.SessionStack` to ensure it is treated as non-null. This change addresses potential nullability warnings and improves code safety and clarity. Applied consistently across all relevant test cases in the `MouseDragTests` class.
2025-12-01 12:54:21 -07:00
ConfigurationManager.Enable (ConfigLocations.All);
using IApplication app = Application.Create ();
app.Init ();
RxApp.MainThreadScheduler = new TerminalScheduler (app);
2020-10-01 13:42:21 +03:00
RxApp.TaskpoolScheduler = TaskPoolScheduler.Default;
Fixes #4419, #4148, #4408 - Toplevel is GONE - Replaced by Runnable (#4422) * WIP: Broken * Got working. Mostly. * Parllel tests pass * More progres * Fixed app tests. * Mouse * more progress. * working on shortcut * Shortcut accept on ENTER is broken. * One left... * More test progress. * All unit tests pass. Still some issues though. * tweak * Fixed Integration Tests * Fixed UI Catalog * Tweaking CP to try to find race condition * Refactor StandardColors and improve ColorPicker logic Refactored `StandardColors` to use lazy initialization for static fields, improving performance and avoiding static constructor convoy effects. Introduced `NamesValueFactory` and `MapValueFactory` methods for encapsulated initialization logic. Simplified `GetColorNames` to directly return `_names.Value`. Improved `TryParseColor` by clarifying default value usage and adopting object initializer syntax. Updated `TryNameColor` to use `_argbNameMap.Value`. Refactored `GetArgb` for better readability. Replaced `MultiStandardColorNameResolver` with `StandardColorsNameResolver` in `ColorPicker`. Commented out `app.Init("Fake")` in `ColorPickerTests` for testing purposes. Made minor formatting improvements, including updated comments and XML documentation for consistency. * revert * Throttle input loop to prevent CPU spinning Introduce a 20ms delay in the input loop of `InputImpl<TInputRecord>` to prevent excessive CPU usage when no input is available. Removed the `DateTime dt = Now();` line and the `while (Peek())` block, which previously enqueued input records. This change improves resource management, especially in scenarios where multiple `ApplicationImpl` instances are created in parallel tests without calling `Shutdown()`. It prevents thread pool exhaustion and ensures better performance in such cases. * Refactor ApplicationImpl to use IDisposable pattern Implemented the IDisposable pattern in ApplicationImpl to improve resource management. Added `Dispose` and `DisposeCore` methods, and marked the `Shutdown` method as obsolete, encouraging the use of `Dispose` or `using` statements instead. Updated the `IApplication` interface to inherit from IDisposable and added `GetResult` methods for retrieving run session results. Refactored unit tests to adopt the new lifecycle management approach, replacing legacy `Shutdown` calls with `Dispose` or `using`. Removed fragile and obsolete tests, and re-enabled previously skipped tests after addressing underlying issues. Updated `FakeApplicationLifecycle` and `SetupFakeApplicationAttribute` to align with the new disposal pattern. Improved documentation and examples to guide users toward modern usage patterns. Maintained backward compatibility for legacy singleton usage. * Add IDisposable pattern with input loop throttling - Add IDisposable to IApplication for proper resource cleanup - Add 20ms throttle to input loop (prevents CPU spinning) - Add Lazy<T> to StandardColors (eliminates convoy effect) - Add MainLoopCoordinatorTests suite (5 new tests) - Add Dispose() calls to all 16 ColorPickerTests - Mark Application.Shutdown() as [Obsolete] IApplication now requires Dispose() for cleanup Performance: 100x CPU reduction, 15x faster disposal, tests complete in <5s Fixes: Thread leaks, CPU saturation, test hangs in parallel execution Docs: Updated application.md and newinv2.md with disposal patterns * Refactor test for input loop throttling clarity Updated `InputLoop_Throttle_Limits_Poll_Rate` test to improve clarity, reliability, and efficiency: - Rewrote summary comment to clarify purpose and emphasize the 20ms throttle's role in preventing CPU spinning. - Replaced `var` with explicit types for better readability. - Reduced test duration from 1s to 500ms to improve test speed. - Revised assertions: - Replaced range-based assertion with upper-bound check to ensure poll count is below 500, avoiding timing sensitivity issues. - Added assertion to verify the thread ran and was not immediately canceled. - Added a 2-second timeout to `inputTask.Wait` and verified task completion. - Improved comments to explain test behavior and reasoning behind changes. * tweaks * Fix nullabiltiy stuff. * runnable fixes * more nullabe * More nullability * warnings gone * Fixed fluent test failure. * Refactor ApplicationImpl and update Runnable layout logic Refactored `ApplicationImpl.Run.cs` for improved readability and atomicity: - Combined `if (wasModal)` with `SessionStack?.TryPop` to streamline logic. - Simplified restoration of `previousRunnable` by reducing nesting. - Updated comments for clarity and retained `SetIsModal` call. Simplified focus-setting logic in `ApplicationImpl.Run.cs` using pattern matching for `TopRunnableView`. In `Runnable<TResult>`, added `SetNeedsLayout` after `IsModalChanged` to ensure layout updates. Removed an unused empty line for cleanup. Corrected namespace in `GetViewsUnderLocationForRootTests.cs` to align with test structure. * Update layout on modal state change A call to `SetNeedsLayout()` was added to the `OnIsModalChanged` method in the `Runnable` class. This ensures that the layout is updated whenever the modal state changes. * Increase test timeout for inputTask.Wait to 10 seconds Extended the timeout duration for the `inputTask.Wait` method from 4 seconds to 10 seconds in `MainLoopCoordinatorTests`. This change ensures the test has a longer window to complete under conditions of increased load or slower execution environments, reducing the likelihood of false test failures. * Refactor project files and simplify test logic Removed `<LangVersion>` and `<ImplicitUsings>` properties from `UnitTests.csproj` and `UnitTests.Parallelizable.csproj` to rely on default SDK settings and disable implicit global usings. Simplified the `SizeChanged_Event_Still_Fires_For_Compatibility` test in `FakeDriverTests` by removing the `screenChangedFired` variable, its associated event handler, and related assertions. Also removed obsolete warning suppression directives as they are no longer needed. * Reduce UnitTestsParallelizable iterations from 10 to 3 Reduced the number of iterations for the UnitTestsParallelizable test suite from 10 to 3 to save time and resources while still exposing concurrency issues. Updated the loop and log messages to reflect the new iteration count. * disabled InputLoop_Throttle_Limits_Poll_Rate * Refactor app lifecycle and improve Runnable API Refactored `Program.cs` to simplify application lifecycle: - Modularized app creation, initialization, and disposal. - Improved result handling and ensured proper resource cleanup. Re-implemented `Runnable<TResult>` with a cleaner design: - Retained functionality while improving readability and structure. - Added XML documentation and followed the Cancellable Work Pattern. Re-implemented `RunnableWrapper<TView, TResult>`: - Enabled wrapping any `View` to make it runnable with typed results. - Added examples and remarks for better developer guidance. Re-implemented `ViewRunnableExtensions`: - Provided fluent API for making views runnable with or without results. - Enhanced documentation with examples for common use cases. General improvements: - Enhanced code readability, maintainability, and error handling. - Replaced redundant code with cleaner, more maintainable versions. * Modernize codebase for Terminal.Gui and MVVM updates Refactored `LoginView` to remove redundant `Application.LayoutAndDraw()` call. Enhanced `LoginViewModel` with new observable properties for automatic property change notifications. Updated `Message` class to use nullable generics for improved type safety. Replaced legacy `Application.Init()` and `Application.Run()` calls with the modern `IApplication` API across `Program.cs`, `Example.cs`, and `ReactiveExample`. Ensured proper disposal of `IApplication` instances to prevent resource leaks. Updated `TerminalScheduler` to integrate with `IApplication` for invoking actions and managing timeouts. Added null checks and improved timeout disposal logic for robustness. Refactored `ExampleWindow` for better readability and alignment with modern `Terminal.Gui` conventions. Cleaned up unused imports and improved code clarity across the codebase. Updated README.md to reflect the latest `Terminal.Gui` practices, including examples of the `IApplication` API and automatic UI refresh handling. Renamed `LoginAction` to `LoginActions` for consistency. * Refactor: Transition to IRunnable-based architecture Replaced `Toplevel` with `Window` as the primary top-level UI element. Introduced the `IRunnable` interface to modernize the architecture, enabling greater flexibility and testability. Deprecated the static `Application` class in favor of the instance-based `IApplication` model, which supports multiple application contexts. Updated methods like `Application.Run()` and `Application.RequestStop()` to use `IRunnable`. Removed or replaced legacy `Modal` properties with `IsModal`. Enhanced the `IApplication` interface with a fluent API, including methods like `Run<TRunnable>()` and `GetResult<T>()`. Refactored tests and examples to align with the new architecture. Updated documentation to reflect the instance-based model. Deprecated obsolete members and methods, including `Application.Current` and `Application.TopRunnable`. Improved event handling by replacing the `Accept` event with `Accepting` and using `e.Handled` for event processing. Updated threading examples to use `App?.Invoke()` or `app.Invoke()` for UI updates. Cleaned up redundant code and redefined modal behavior for better consistency. These changes modernize the `Terminal.Gui` library, improving clarity, usability, and maintainability while ensuring backward compatibility where possible. * Refactor: Replace Toplevel with Runnable class This commit introduces a major architectural update to the `Terminal.Gui` library, replacing the legacy `Toplevel` class with the new `Runnable` class. The changes span the entire codebase, including core functionality, tests, documentation, and configuration files. - **Core Class Replacement**: - Replaced `Toplevel` with `Runnable` as the base class for modal views and session management. - Updated all references to `Toplevel` in the codebase, including constructors, methods, and properties. - **Configuration Updates**: - Updated `tui-config-schema.json` to reflect the new `Runnable` scheme. - **New Classes**: - Added `UICatalogRunnable` for managing the UI Catalog application. - Introduced `Runnable<TResult>` as a generic base class for blocking sessions with result handling. - **Documentation and Tests**: - Updated documentation to emphasize `Runnable` and mark `Toplevel` as obsolete. - Refactored test cases to use `Runnable` and ensure compatibility. - **Behavioral Improvements**: - Enhanced lifecycle management and alignment with the `IRunnable` interface. - Improved clarity and consistency in naming conventions. These changes modernize the library, improve flexibility, and provide a clearer architecture for developers. * Refactor: Consolidate Runnable classes and decouple View from ApplicationImpl - Made Runnable<TResult> inherit from Runnable (eliminating ~180 LOC duplication) - Moved View init/layout/cursor logic from ApplicationImpl to Runnable lifecycle events - ApplicationImpl.Begin now operates purely on IRunnable interface Related to #4419 * Simplified the disposal logic in `ApplicationImpl.Run.cs` by replacing the type-specific check for `View` with a more general check for `IDisposable`. This ensures proper disposal of any `IDisposable` object, improving robustness. Removed the `FrameworkOwnedRunnable` property from the `ApplicationImpl` class in `ApplicationImpl.cs` and the `IApplication` interface in `IApplication.cs`. This eliminates the need to manage this property, reducing complexity and improving maintainability. Updated `application.md` to reflect the removal of the `FrameworkOwnedRunnable` property, ensuring the documentation aligns with the updated codebase. * Replaces the legacy `Shutdown()` method with `Dispose()` to align with the `IDisposable` pattern, ensuring proper resource cleanup and simplifying the API. The `Dispose()` method is now the recommended way to release resources, with `using` statements encouraged for automatic disposal. Key changes: - Marked `Shutdown()` as obsolete; it now internally calls `Dispose()`. - Updated the fluent API to remove `Shutdown()` from chaining. - Enhanced session lifecycle management for thread safety. - Updated tests to validate proper disposal and state reset. - Improved `IRunnable` integration with automatic disposal for framework-created runnables. - Maintained backward compatibility for the legacy static `Application` singleton. - Refactored documentation and examples to reflect modern practices and emphasize `Dispose()` usage. These changes modernize the `Terminal.Gui` lifecycle, improve testability, and encourage alignment with .NET conventions. * Refactor runnable app context handling in ApplicationImpl Refactor how the application context is set for `runnable` objects by introducing a new `SetApp` method in the `IRunnable` interface. This replaces the previous logic of directly setting the `App` property for `View` objects, making the process more generic and encapsulated within `IRunnable` implementations. Simplify `Mouse.UngrabMouse()` by removing the conditional check and calling it unconditionally. Make a minor formatting adjustment in the generic constraint of `Run<TRunnable>` in `ApplicationImpl`. Add `SetApp(IApplication app)` to the `IRunnable` interface and implement it in the `Runnable` class to set the `App` property to the provided application instance. * Improve docs, tests, and modularity across the codebase Reorganized and updated `CONTRIBUTING.md`: - Added **Key Architecture Concepts** section and reordered the table of contents. - Updated testing requirements to discourage legacy patterns. - Added instructions for replicating CI workflows locally. - Clarified PR guidelines and coding style expectations. Enhanced `README.md` with detailed CI/CD workflow documentation. Refactored `ColorPicker.Prompt` to use `IApplication` for improved modularity and testability. Introduced `IApplicationScreenChangedTests` for comprehensive testing of `ScreenChanged` events and `Screen` property. Refactored `ApplicationScreenTests` and `TextView.PromptForColors` to align with modern patterns. Updated `Terminal.sln` to include `.github/workflows/README.md`. Performed general cleanup: - Removed outdated documentation links. - Improved XML documentation and coding consistency. * readme tweaks * Improve thread safety, layout, and test coverage Refactored `OutputBufferImpl.cs` to enhance thread safety by locking shared resources and adding bounds checks for columns and rows. Improved handling of wide characters and removed outdated TODO comments. Updated `Runnable.cs` to call `SetNeedsDraw()` on modal state changes, ensuring proper layout and drawing updates. Simplified layout handling in `ApplicationImpl.Run.cs` by replacing redundant comments with a `LayoutAndDraw()` call. Added a check in `AllViewsTester.cs` to skip creating instances of `RunnableWrapper` types with unsatisfiable generic constraints, logging a warning when encountered. Enhanced `ListViewTests.cs` by adding explicit `app.LayoutAndDraw()` calls to validate visual output and ensure tests reflect the updated application state. These changes improve robustness, prevent race conditions, and ensure consistent behavior across the application. * Refactor: Rename Toplevel to Runnable and update logic Updated the `Border` class to use `Command.Quit` instead of `Command.QuitToplevel` in the `CloseButton.Accept` handler. Renamed test methods in `GetViewsAtLocationTests.cs` to replace "Toplevel" with "Runnable" for consistency. Updated `Runnable<bool>` instances to use "topRunnable" as the `Id` property. These changes align the codebase with updated naming conventions and improve clarity. * Removed `ToplevelTests` and migrated relevant test cases to `MouseDragTests` with improved structure and coverage. Updated tests to use `Application.Create`, `app.Begin`, and `app.End` for better resource management and lifecycle handling. Replaced direct event handling with `app.Mouse.RaiseMouseEvent` to align with the application's event-handling mechanism. Added `Runnable` objects to ensure views are properly initialized and disposed of within the application context. Enhanced tests to include assertions for minimum width and height constraints during resize operations. Removed redundant tests and streamlined logic to reduce duplication and improve maintainability. * Reorged Unit Test namespaces. * more * Refactor tests and update namespaces for consistency Updated namespaces in `ArrangementTests.cs` and `MouseDragTests.cs` for better organization. Enhanced `ArrangementTests.cs` with additional checks for arrangement flags. Reformatted and re-added `MouseDragTests.cs` and `SchemeTests.cs` with modern C# features like nullable annotations and object initializers. Ensured no functional changes while improving code clarity and consistency. * Fix nullability warnings in MouseDragTests.cs Updated `app.End` calls to use the null-forgiving operator (`!`) on `app.SessionStack` to ensure it is treated as non-null. This change addresses potential nullability warnings and improves code safety and clarity. Applied consistently across all relevant test cases in the `MouseDragTests` class.
2025-12-01 12:54:21 -07:00
var loginView = new LoginView (new ());
app.Run (loginView);
loginView.Dispose ();
2020-10-01 13:42:21 +03:00
```
From now on, you can use `.ObserveOn(RxApp.MainThreadScheduler)` to return to the main loop from a background thread. This is useful when you have a `IObservable<TValue>` updated from a background thread, and you wish to update the UI with `TValue`s received from that observable.
2020-10-01 12:45:38 +03:00
### Data Bindings
Fixes #2926 - Refactor KeyEvent and KeyEventEventArgs to simplify (#2927) * Adds basic MainLoop unit tests * Remove WinChange action from Curses * Remove WinChange action from Curses * Remove ProcessInput action from Windows MainLoop * Simplified MainLoop/ConsoleDriver by making MainLoop internal and moving impt fns to Application * Modernized Terminal resize events * Modernized Terminal resize events * Removed un used property * for _isWindowsTerminal devenv->wininit; not sure what changed * Modernized mouse/keyboard events (Action->EventHandler) * Updated OnMouseEvent API docs * Using WT_SESSION to detect WT * removes hacky GetParentProcess * Updates to fix #2634 (clear last line) * removes hacky GetParentProcess2 * Addressed mac resize issue * Addressed mac resize issue * Removes ConsoleDriver.PrepareToRun, has Init return MainLoop * Removes unneeded Attribute methods * Removed GetProcesssName * Removed GetProcesssName * Refactored KeyEvent and KeyEventEventArgs into a single class * Revert "Refactored KeyEvent and KeyEventEventArgs into a single class" This reverts commit 88a00658dbcb53306d56af1b766594c0eea10b2c. * Fixed key repeat issue; reverted stupidity on 1049/1047 confusion * Updated CSI API Docs * merge * Rearranged Event.cs to Keyboard.cs and Mouse.cs * Renamed KeyEventEventArgs KeyEventArgs * temp renamed KeyEvent OldKeyEvent * Merged KeyEvent into KeyEventArgs * Renamed Application.ProcessKey members * Renamed Application.ProcessKey members * Renamed Application.ProcessKey members * Added Responder.KeyPressed * Removed unused references * Fixed arg naming * InvokeKeybindings->InvokeKeyBindings * InvokeKeybindings->InvokeKeyBindings * Fixed unit tests fail * More progress on refactoring key input; still broken and probably wrong * Moved OnKeyPressed out of Responder and made ProcessKeyPrssed non-virtual * Updated API docs * Moved key handling from Responder to View * Updated API docs * Updated HotKey API docs * Updated shortcut API docs * Fixed responder unit tests * Removed Shortcut from View as it is not used * Removed unneeded OnHotKey override from Button * Fixed BackTab logic * Button now uses Key Bindings exclusively * Button now uses Key Bindings exclusively * Updated keyboard.md docs * Fixed unit tests to account for Toplevel handling default button * Added View.InvokeCommand API * Modernized RadioGroup * Removed ColdKey * Modernized (partially) StatusBar * Worked around FileDialog issue with Ctrl-F * Fixed driver unit test; view must be focused to reciev key pressed * Application code cleanup * Start on updaing menu * Menu now mostly works * Menu Select refinement * Fixed known menu bugs! * Enabled HotKey to cause focus- experimental * Fixes #3022 & adds unit test to prove it * Actually Fixes #3022 & adds unit test to prove it * Working through hotkey issues * Misc fixes * removed hot/cold key stuff from Keys scenario * Fixed scenarios * Simplified shortcut string handling * Modernized Checkbox * Modernized TileView * Updated API docs * Updated API docs * attempting to publish v2 docs * Revert "attempting to publish v2 docs" This reverts commit 59dcec111b63121ca34f890d76728f40e81412b3. * Playing with api docs * Removed Key.BackTab * Removed Caps/Scroll/Numlock * Partial removal of keymodifiers - unit tests pass * Partial removal of keymodifiers - broke netdriver somewhere * WindowsDriver & added KeyEventArgsTests * Fixing menu shortcut/hotkeys - broke Menu.cs into separate files * Fixed MenuBar! * Finished modernizing Menu/MenuBar * Removed Key.a-z. Broke lots of stuff * checkout@v4 * progress on key mapping and formatting * VK tests are still failing * Fixed some unit tests * Added Hotkey and Keybinding unit tests * fixed unit test * All unit tests pass again... * Fixed broken unit tests * KeyEventArgs.KeyValue -> AsRune * Fixed bugs. Still some broken * Added KeyEventArgs.IsAlpha. Added KeyEventArgs.cast ops. Fixed bugs. Unit tests pass * Fixed WindowsDriver * Oops. * Refactoring based on bdisp's help. Not complete! * removed calling into subviews from OnKeyBindings * removed calling into subviews from OnKeyBindings * Improved View KeyEvent unit tests * More hotkey unit tests * BIg change - Got rid of KeyPress w/in Application/Drivers * Unit tests now pass again * Refreshed API docs * Better HotKey logic. More progress. Getting close. * Fixed handling of shifted chars like ö * Minor code cleanup * Minor code cleanup2 * Why is build Action failing? * Why is build Action failing?? * upgraded to .net8 to try to fix weird CI/CD build errors * upgraded to .net8 to try to fix weird CI/CD build errors2 * Disabling TextViewTests to diagnose build errors * reenable TextViewTests to diagnose build errors * Arrrrrrg * Merged v2_develop * Fixed uppercase accented keys in WindowsDriver * Fixed key binding api docs * Experimental impl of CommandScope.SubViews for MenuBar * Removed dead code from application.cs * Removed dead code from application.cs * Removed dead code from ConsoleDriver.cs * Cleaned up some key binding stuff * Disabled Alt to activate menu for now * Updated label commands * Fixed menu bugs. Upgraded menu unit tests * Fixed unit tests * Working on NetDriver * fixed netdriver * Fixed issues called out by @bdisp CR * fixed CursesDriver * added todo to netdriver * Cherry picked treeview test fix 1b415e5 * Fix NetDriver. * CommandScope->KeyBindingScope * Address some tznind feedback * Refactored KeyBindings big time! * Added key consts to KeyEventArgs and renamed Key to ConsoleDriverKey * Fixed some API docs * Moved ConsoleDriverKey to ConsoleDriver.cs * Renamed Key->ConsoleDriverKey * Renamed Key->ConsoleDriverKey * Renamed Key->ConsoleDriverKey * renamed file I forgot to rename before * Updated name and API docs of KeyEventArgs.isAlpha * Fixed issues with OnKeyUp not doing the right thing. * Fixed MainLoop.Running never being used * Fixed MainLoop.Running never being used - unit tests * Claned up BUGBUG comments * Disabled a unit test to see why ci/cd tests are failing * Removed defunct commented code * Removed more defunct commented code * Re-eanbled unit test; jsut removing one test case... * Disabled more... * Renambed Global->Applicaton and updated scope API docs * Disabled more unit tests... * Removed dead code * Disabled more unit tests...2 * Disabled more unit tests...3 * Renambed Global->Applicaton and updated scope API docs 2 * Added more KeyBinding scope tests * Added more KeyBinding scope tests2 * ConsoleDriverKey too long. Key too ambiguous. Settled on KeyCode. (Partialy because eventually I want to intro a class named Key). * KeyEventArgs improvements. cast to Rune must be explicit as it's lossy * Fixed warnings * Renamed KeyEventArgs to Key... progress on fixing broken stuff that resulted * Fix ConsoleKeyMapping bugs. * Fix NetDriver issue from converting a lower case to a upper case. * Started migration to Key from KeyCode - e.g. made HotKeys all consistent. * Fixed build warnings * Added key defns to Key * KeyBindings now uses Key vs. KeyCode * Verified by tweaking UICatalog * Fixed treeview test ... again * Renamed ProcessKeyDown/Up to NewKeyDown/Up and OnKeyPressed to OnProcessKeyDown to make things more clear * Added test AllViews_KeyDown_All_EventsFire unit tests and fixed a few Views that were wrong * fixed stupid KeyUp event bug * If key not handled, return false for datefield * dotnet test --no-restore --verbosity diag * dotnet test --blame * run tests on windows * Fix TestVKPacket unit test and move it to ConsoleKeyMappingTests.cs file. * Remove unnecessary commented code. * Tweaked unit tests and removed Key.BareKey * Fixed little details and updated api docs * updated api docs * AddKeyBindingsForHotKey: KeyCode->Key * Cleaned up more old KeyCode usages. Added TODOs --------- Co-authored-by: BDisp <bd.bdisp@gmail.com>
2023-12-16 12:04:23 -07:00
If you wish to implement `OneWay` data binding, then use the `WhenAnyValue` [ReactiveUI extension method](https://www.reactiveui.net../docs/handbook/when-any/) that listens to `INotifyPropertyChanged` events of the specified property, and converts that events into `IObservable<TProperty>`:
2020-10-01 12:45:38 +03:00
```cs
// 'usernameInput' is 'TextField'
ViewModel
.WhenAnyValue (x => x.Username)
.BindTo (usernameInput, x => x.Text);
```
Note that your view model should implement `INotifyPropertyChanged` or inherit from a `ReactiveObject`. If you wish to implement `OneWayToSource` data binding, then install [Pharmacist.MSBuild](https://github.com/reactiveui/pharmacist) into your project and listen to e.g. `TextChanged` event of a `TextField`:
```cs
// 'usernameInput' is 'TextField'
usernameInput
.Events () // The Events() extension is generated by Pharmacist.
.TextChanged
.Select (old => usernameInput.Text)
.DistinctUntilChanged ()
.BindTo (ViewModel, x => x.Username);
```
Fixes #92. Remove dependency on ustring. (#2620) * Remove NStack and replace ustring to string. * Add unit test and improving some code. * Adjust code and fix all unit tests errors. * Add XML Document and move the Rune folder into the Text folder. * Improve unit tests with byte array on DecodeRune and DecodeLastRune. * Fix unit test. * 😂Code review * Reduce unit tests code. * Change StringExtensions.Make to StringExtensions.ToString and added some more unit tests. * Fix merge errors. * Remove GetTextWidth and calls replaced with StringExtensions.GetColumns. * Hack to use UseSystemConsole passed in the command line arguments. * Revert "Hack to use UseSystemConsole passed in the command line arguments." This reverts commit b74d11c7864fa6e20d40ef5cbead89a42f81ee5e. * Remove Application.UseSystemConsole from the config file. * Fix errors related by removing UseSystemConsole from the config file. * Fixes #2633. DecodeEscSeq throw an exception if cki is null. * Fix an exception if SelectedItem is -1. * Set SelectedItem to 0 and remove unnecessary ToString. * Using a unique ToString method for Rune and other for byte. * Fix a bug where a wider rune is added with only a width of 1. * Force the SelectedGlyph is the one that was typed after jumpList is executed. * Added more InlineData to RuneTests. * Reducing significantly the code by using Theory attribute in the TextFormatterTests. * Override PositionCursor to handle the CharMap cursor position. * Fix merge errors. * Minor tweaks to API docs --------- Co-authored-by: Tig Kindel <tig@users.noreply.github.com>
2023-05-20 18:35:32 +01:00
If you combine `OneWay` and `OneWayToSource` data bindings, you get `TwoWay` data binding. Also be sure to use the `string` type instead of the `string` type. Invoking commands should be as simple as this:
2020-10-01 12:45:38 +03:00
```cs
// 'clearButton' is 'Button'
clearButton
.Events ()
Fixes #4419, #4148, #4408 - Toplevel is GONE - Replaced by Runnable (#4422) * WIP: Broken * Got working. Mostly. * Parllel tests pass * More progres * Fixed app tests. * Mouse * more progress. * working on shortcut * Shortcut accept on ENTER is broken. * One left... * More test progress. * All unit tests pass. Still some issues though. * tweak * Fixed Integration Tests * Fixed UI Catalog * Tweaking CP to try to find race condition * Refactor StandardColors and improve ColorPicker logic Refactored `StandardColors` to use lazy initialization for static fields, improving performance and avoiding static constructor convoy effects. Introduced `NamesValueFactory` and `MapValueFactory` methods for encapsulated initialization logic. Simplified `GetColorNames` to directly return `_names.Value`. Improved `TryParseColor` by clarifying default value usage and adopting object initializer syntax. Updated `TryNameColor` to use `_argbNameMap.Value`. Refactored `GetArgb` for better readability. Replaced `MultiStandardColorNameResolver` with `StandardColorsNameResolver` in `ColorPicker`. Commented out `app.Init("Fake")` in `ColorPickerTests` for testing purposes. Made minor formatting improvements, including updated comments and XML documentation for consistency. * revert * Throttle input loop to prevent CPU spinning Introduce a 20ms delay in the input loop of `InputImpl<TInputRecord>` to prevent excessive CPU usage when no input is available. Removed the `DateTime dt = Now();` line and the `while (Peek())` block, which previously enqueued input records. This change improves resource management, especially in scenarios where multiple `ApplicationImpl` instances are created in parallel tests without calling `Shutdown()`. It prevents thread pool exhaustion and ensures better performance in such cases. * Refactor ApplicationImpl to use IDisposable pattern Implemented the IDisposable pattern in ApplicationImpl to improve resource management. Added `Dispose` and `DisposeCore` methods, and marked the `Shutdown` method as obsolete, encouraging the use of `Dispose` or `using` statements instead. Updated the `IApplication` interface to inherit from IDisposable and added `GetResult` methods for retrieving run session results. Refactored unit tests to adopt the new lifecycle management approach, replacing legacy `Shutdown` calls with `Dispose` or `using`. Removed fragile and obsolete tests, and re-enabled previously skipped tests after addressing underlying issues. Updated `FakeApplicationLifecycle` and `SetupFakeApplicationAttribute` to align with the new disposal pattern. Improved documentation and examples to guide users toward modern usage patterns. Maintained backward compatibility for legacy singleton usage. * Add IDisposable pattern with input loop throttling - Add IDisposable to IApplication for proper resource cleanup - Add 20ms throttle to input loop (prevents CPU spinning) - Add Lazy<T> to StandardColors (eliminates convoy effect) - Add MainLoopCoordinatorTests suite (5 new tests) - Add Dispose() calls to all 16 ColorPickerTests - Mark Application.Shutdown() as [Obsolete] IApplication now requires Dispose() for cleanup Performance: 100x CPU reduction, 15x faster disposal, tests complete in <5s Fixes: Thread leaks, CPU saturation, test hangs in parallel execution Docs: Updated application.md and newinv2.md with disposal patterns * Refactor test for input loop throttling clarity Updated `InputLoop_Throttle_Limits_Poll_Rate` test to improve clarity, reliability, and efficiency: - Rewrote summary comment to clarify purpose and emphasize the 20ms throttle's role in preventing CPU spinning. - Replaced `var` with explicit types for better readability. - Reduced test duration from 1s to 500ms to improve test speed. - Revised assertions: - Replaced range-based assertion with upper-bound check to ensure poll count is below 500, avoiding timing sensitivity issues. - Added assertion to verify the thread ran and was not immediately canceled. - Added a 2-second timeout to `inputTask.Wait` and verified task completion. - Improved comments to explain test behavior and reasoning behind changes. * tweaks * Fix nullabiltiy stuff. * runnable fixes * more nullabe * More nullability * warnings gone * Fixed fluent test failure. * Refactor ApplicationImpl and update Runnable layout logic Refactored `ApplicationImpl.Run.cs` for improved readability and atomicity: - Combined `if (wasModal)` with `SessionStack?.TryPop` to streamline logic. - Simplified restoration of `previousRunnable` by reducing nesting. - Updated comments for clarity and retained `SetIsModal` call. Simplified focus-setting logic in `ApplicationImpl.Run.cs` using pattern matching for `TopRunnableView`. In `Runnable<TResult>`, added `SetNeedsLayout` after `IsModalChanged` to ensure layout updates. Removed an unused empty line for cleanup. Corrected namespace in `GetViewsUnderLocationForRootTests.cs` to align with test structure. * Update layout on modal state change A call to `SetNeedsLayout()` was added to the `OnIsModalChanged` method in the `Runnable` class. This ensures that the layout is updated whenever the modal state changes. * Increase test timeout for inputTask.Wait to 10 seconds Extended the timeout duration for the `inputTask.Wait` method from 4 seconds to 10 seconds in `MainLoopCoordinatorTests`. This change ensures the test has a longer window to complete under conditions of increased load or slower execution environments, reducing the likelihood of false test failures. * Refactor project files and simplify test logic Removed `<LangVersion>` and `<ImplicitUsings>` properties from `UnitTests.csproj` and `UnitTests.Parallelizable.csproj` to rely on default SDK settings and disable implicit global usings. Simplified the `SizeChanged_Event_Still_Fires_For_Compatibility` test in `FakeDriverTests` by removing the `screenChangedFired` variable, its associated event handler, and related assertions. Also removed obsolete warning suppression directives as they are no longer needed. * Reduce UnitTestsParallelizable iterations from 10 to 3 Reduced the number of iterations for the UnitTestsParallelizable test suite from 10 to 3 to save time and resources while still exposing concurrency issues. Updated the loop and log messages to reflect the new iteration count. * disabled InputLoop_Throttle_Limits_Poll_Rate * Refactor app lifecycle and improve Runnable API Refactored `Program.cs` to simplify application lifecycle: - Modularized app creation, initialization, and disposal. - Improved result handling and ensured proper resource cleanup. Re-implemented `Runnable<TResult>` with a cleaner design: - Retained functionality while improving readability and structure. - Added XML documentation and followed the Cancellable Work Pattern. Re-implemented `RunnableWrapper<TView, TResult>`: - Enabled wrapping any `View` to make it runnable with typed results. - Added examples and remarks for better developer guidance. Re-implemented `ViewRunnableExtensions`: - Provided fluent API for making views runnable with or without results. - Enhanced documentation with examples for common use cases. General improvements: - Enhanced code readability, maintainability, and error handling. - Replaced redundant code with cleaner, more maintainable versions. * Modernize codebase for Terminal.Gui and MVVM updates Refactored `LoginView` to remove redundant `Application.LayoutAndDraw()` call. Enhanced `LoginViewModel` with new observable properties for automatic property change notifications. Updated `Message` class to use nullable generics for improved type safety. Replaced legacy `Application.Init()` and `Application.Run()` calls with the modern `IApplication` API across `Program.cs`, `Example.cs`, and `ReactiveExample`. Ensured proper disposal of `IApplication` instances to prevent resource leaks. Updated `TerminalScheduler` to integrate with `IApplication` for invoking actions and managing timeouts. Added null checks and improved timeout disposal logic for robustness. Refactored `ExampleWindow` for better readability and alignment with modern `Terminal.Gui` conventions. Cleaned up unused imports and improved code clarity across the codebase. Updated README.md to reflect the latest `Terminal.Gui` practices, including examples of the `IApplication` API and automatic UI refresh handling. Renamed `LoginAction` to `LoginActions` for consistency. * Refactor: Transition to IRunnable-based architecture Replaced `Toplevel` with `Window` as the primary top-level UI element. Introduced the `IRunnable` interface to modernize the architecture, enabling greater flexibility and testability. Deprecated the static `Application` class in favor of the instance-based `IApplication` model, which supports multiple application contexts. Updated methods like `Application.Run()` and `Application.RequestStop()` to use `IRunnable`. Removed or replaced legacy `Modal` properties with `IsModal`. Enhanced the `IApplication` interface with a fluent API, including methods like `Run<TRunnable>()` and `GetResult<T>()`. Refactored tests and examples to align with the new architecture. Updated documentation to reflect the instance-based model. Deprecated obsolete members and methods, including `Application.Current` and `Application.TopRunnable`. Improved event handling by replacing the `Accept` event with `Accepting` and using `e.Handled` for event processing. Updated threading examples to use `App?.Invoke()` or `app.Invoke()` for UI updates. Cleaned up redundant code and redefined modal behavior for better consistency. These changes modernize the `Terminal.Gui` library, improving clarity, usability, and maintainability while ensuring backward compatibility where possible. * Refactor: Replace Toplevel with Runnable class This commit introduces a major architectural update to the `Terminal.Gui` library, replacing the legacy `Toplevel` class with the new `Runnable` class. The changes span the entire codebase, including core functionality, tests, documentation, and configuration files. - **Core Class Replacement**: - Replaced `Toplevel` with `Runnable` as the base class for modal views and session management. - Updated all references to `Toplevel` in the codebase, including constructors, methods, and properties. - **Configuration Updates**: - Updated `tui-config-schema.json` to reflect the new `Runnable` scheme. - **New Classes**: - Added `UICatalogRunnable` for managing the UI Catalog application. - Introduced `Runnable<TResult>` as a generic base class for blocking sessions with result handling. - **Documentation and Tests**: - Updated documentation to emphasize `Runnable` and mark `Toplevel` as obsolete. - Refactored test cases to use `Runnable` and ensure compatibility. - **Behavioral Improvements**: - Enhanced lifecycle management and alignment with the `IRunnable` interface. - Improved clarity and consistency in naming conventions. These changes modernize the library, improve flexibility, and provide a clearer architecture for developers. * Refactor: Consolidate Runnable classes and decouple View from ApplicationImpl - Made Runnable<TResult> inherit from Runnable (eliminating ~180 LOC duplication) - Moved View init/layout/cursor logic from ApplicationImpl to Runnable lifecycle events - ApplicationImpl.Begin now operates purely on IRunnable interface Related to #4419 * Simplified the disposal logic in `ApplicationImpl.Run.cs` by replacing the type-specific check for `View` with a more general check for `IDisposable`. This ensures proper disposal of any `IDisposable` object, improving robustness. Removed the `FrameworkOwnedRunnable` property from the `ApplicationImpl` class in `ApplicationImpl.cs` and the `IApplication` interface in `IApplication.cs`. This eliminates the need to manage this property, reducing complexity and improving maintainability. Updated `application.md` to reflect the removal of the `FrameworkOwnedRunnable` property, ensuring the documentation aligns with the updated codebase. * Replaces the legacy `Shutdown()` method with `Dispose()` to align with the `IDisposable` pattern, ensuring proper resource cleanup and simplifying the API. The `Dispose()` method is now the recommended way to release resources, with `using` statements encouraged for automatic disposal. Key changes: - Marked `Shutdown()` as obsolete; it now internally calls `Dispose()`. - Updated the fluent API to remove `Shutdown()` from chaining. - Enhanced session lifecycle management for thread safety. - Updated tests to validate proper disposal and state reset. - Improved `IRunnable` integration with automatic disposal for framework-created runnables. - Maintained backward compatibility for the legacy static `Application` singleton. - Refactored documentation and examples to reflect modern practices and emphasize `Dispose()` usage. These changes modernize the `Terminal.Gui` lifecycle, improve testability, and encourage alignment with .NET conventions. * Refactor runnable app context handling in ApplicationImpl Refactor how the application context is set for `runnable` objects by introducing a new `SetApp` method in the `IRunnable` interface. This replaces the previous logic of directly setting the `App` property for `View` objects, making the process more generic and encapsulated within `IRunnable` implementations. Simplify `Mouse.UngrabMouse()` by removing the conditional check and calling it unconditionally. Make a minor formatting adjustment in the generic constraint of `Run<TRunnable>` in `ApplicationImpl`. Add `SetApp(IApplication app)` to the `IRunnable` interface and implement it in the `Runnable` class to set the `App` property to the provided application instance. * Improve docs, tests, and modularity across the codebase Reorganized and updated `CONTRIBUTING.md`: - Added **Key Architecture Concepts** section and reordered the table of contents. - Updated testing requirements to discourage legacy patterns. - Added instructions for replicating CI workflows locally. - Clarified PR guidelines and coding style expectations. Enhanced `README.md` with detailed CI/CD workflow documentation. Refactored `ColorPicker.Prompt` to use `IApplication` for improved modularity and testability. Introduced `IApplicationScreenChangedTests` for comprehensive testing of `ScreenChanged` events and `Screen` property. Refactored `ApplicationScreenTests` and `TextView.PromptForColors` to align with modern patterns. Updated `Terminal.sln` to include `.github/workflows/README.md`. Performed general cleanup: - Removed outdated documentation links. - Improved XML documentation and coding consistency. * readme tweaks * Improve thread safety, layout, and test coverage Refactored `OutputBufferImpl.cs` to enhance thread safety by locking shared resources and adding bounds checks for columns and rows. Improved handling of wide characters and removed outdated TODO comments. Updated `Runnable.cs` to call `SetNeedsDraw()` on modal state changes, ensuring proper layout and drawing updates. Simplified layout handling in `ApplicationImpl.Run.cs` by replacing redundant comments with a `LayoutAndDraw()` call. Added a check in `AllViewsTester.cs` to skip creating instances of `RunnableWrapper` types with unsatisfiable generic constraints, logging a warning when encountered. Enhanced `ListViewTests.cs` by adding explicit `app.LayoutAndDraw()` calls to validate visual output and ensure tests reflect the updated application state. These changes improve robustness, prevent race conditions, and ensure consistent behavior across the application. * Refactor: Rename Toplevel to Runnable and update logic Updated the `Border` class to use `Command.Quit` instead of `Command.QuitToplevel` in the `CloseButton.Accept` handler. Renamed test methods in `GetViewsAtLocationTests.cs` to replace "Toplevel" with "Runnable" for consistency. Updated `Runnable<bool>` instances to use "topRunnable" as the `Id` property. These changes align the codebase with updated naming conventions and improve clarity. * Removed `ToplevelTests` and migrated relevant test cases to `MouseDragTests` with improved structure and coverage. Updated tests to use `Application.Create`, `app.Begin`, and `app.End` for better resource management and lifecycle handling. Replaced direct event handling with `app.Mouse.RaiseMouseEvent` to align with the application's event-handling mechanism. Added `Runnable` objects to ensure views are properly initialized and disposed of within the application context. Enhanced tests to include assertions for minimum width and height constraints during resize operations. Removed redundant tests and streamlined logic to reduce duplication and improve maintainability. * Reorged Unit Test namespaces. * more * Refactor tests and update namespaces for consistency Updated namespaces in `ArrangementTests.cs` and `MouseDragTests.cs` for better organization. Enhanced `ArrangementTests.cs` with additional checks for arrangement flags. Reformatted and re-added `MouseDragTests.cs` and `SchemeTests.cs` with modern C# features like nullable annotations and object initializers. Ensured no functional changes while improving code clarity and consistency. * Fix nullability warnings in MouseDragTests.cs Updated `app.End` calls to use the null-forgiving operator (`!`) on `app.SessionStack` to ensure it is treated as non-null. This change addresses potential nullability warnings and improves code safety and clarity. Applied consistently across all relevant test cases in the `MouseDragTests` class.
2025-12-01 12:54:21 -07:00
.Accepting
2020-10-01 12:45:38 +03:00
.InvokeCommand (ViewModel, x => x.Clear);
```